Improve README, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md for Better User and Contributor Guidance #24
Conversation
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
1 participant
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.
This pull request enhances the documentation for the project by:
README.md: Added simplified installation instructions for new users and linked to the CONTRIBUTING.md for detailed setup steps.
CONTRIBUTING.md: Improved contribution guidelines with instructions for contributing to the documentation and coding standards (including the use of flake8 for linting).
PULL_REQUEST_TEMPLATE.md: Updated the template to ensure contributors document their changes, check dependencies, and run linting checks before submitting a pull request.
These changes aim to improve the onboarding process for both users and contributors by providing clear instructions and ensuring better quality contributions.