feat(docs): add testing instructions to docs#10
Merged
Conversation
hoangsonww
added
documentation
✅ Deploy Preview for fullstack-learning-management-system canceled.
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the project documentation by introducing a new Testing section that guides contributors on running both backend and frontend test suites.
- Updated the table of contents to include Testing, Backend Tests, and Frontend Tests links
- Reformatted the existing Global Note admonition for consistency
- Added step-by-step commands for executing backend (pytest) and frontend (npm) tests
Comments suppressed due to low confidence (3)
README.md:35
- [nitpick] The nested list items under 'Testing' in the TOC use inconsistent indentation. Use consistent spaces (e.g., two spaces) before each dash to correctly nest these items under 'Testing'.
- [Backend Tests](#backend-tests)
README.md:170
- The admonition formatting combines two '>' markers in one line, which may render improperly. Consider splitting it into separate lines each starting with '>' to match Markdown blockquote style:
> [!IMPORTANT] > **Note:** Our backend server may spin down due to inactivity, so you may experience delays in loading data initially as the backend is hosted on the free tier of Render. If you encounter any issues, please let me know.
README.md:841
- [nitpick] Consider adding a note about prerequisite steps, such as installing dependencies (
npm installin the frontend andpip install -r requirements.txtin the backend), to help new contributors set up tests without errors.
The project includes unit tests for both the backend and frontend applications. You can run the tests using the following commands:
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.
No description provided.