Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md for Better User and Contributor Guidance #24

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Akeeb4316
Copy link

This pull request enhances the documentation for the project by:

  1. README.md: Added simplified installation instructions for new users and linked to the CONTRIBUTING.md for detailed setup steps.

  2. CONTRIBUTING.md: Improved contribution guidelines with instructions for contributing to the documentation and coding standards (including the use of flake8 for linting).

  3. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant