Few README.md updates - #6181
Open
MMilosz wants to merge 4 commits into
Open
Conversation
- remove nonexisting #deploy - rename #collaborating -> #contributing - add missing sections
- `npm run coverage` does not exist, replace with `npm run test: headless` and `npm run test:watch` - update E2E extension `.spec.ts` -> `.cy.ts` - minor grammar changes
- delete paragraph about `pre` or `post` scripts to reflect current package.json state - mention `npm run` can be used to see the available scripts - mention `npm run <script-name>`
- use Markdown Alert in 'Running the application with Docker' - remove deprecated 'Debugger for Chrome' under 'Visual Studio Code' (it's now built natively into VS Code) - mention .editorconfig under 'Recommended Editors/IDEs' - mention more relevant files in 'File Structure', also fix some entries that doesn't exist or use different name, also update http->https - in FAQ, remove 'node-pre-gyp ERR in npm install' - python 2 has been deprecated for years - official Node.js for Windows installer now automatically installs the required tools - minor changes (Typescript -> TypeScript, TYPEDOC -> TypeDoc, --save-dev -> --save-dev, etc.)
MMilosz
marked this pull request as ready for review
September 4, 2026 14:05
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
References
None
Description
Few maintenance updates to README documentation. Changes reflected in commit history.
Note: the README would benefit from a more thorough re-visit
Changes
npm run coverage(it does not exist) withnpm run test:headlessandnpm run test:watch, updated Cypress extension.spec.ts->.cy.tspreorpostscripts (pree2e,prebuildetc. were used before 2021, see: 71f5b46), added info onnpm run&npm run <script-name>Instructions for Reviewers
No functional changes. Review changes in
README.mdChecklist
Note: I've checked all items in the checklist as this is a documentation-only update, so code-related items do not apply.
mainbranch of code (unless it is a backport or is fixing an issue specific to an older branch).npm run lintnpm run check-circ-deps)package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.