Right now, the README file in the repository only has basic instructions for how to contribute. These are useful, but they don't cover everything that new contributors need to know. Putting a separate CONTRIBUTING.md file in place would make things more clearer and easier to understand.
Suggested contents for CONTRIBUTING.md:
- Setup instructions for backend (Python) and frontend (Node.js)
- Coding standards (linting, formatting, commit message style)
- Testing guidelines (how to run tests, expectations for coverage)
- Issue workflow (how to report bugs, request features, or claim issues)
- Pull request checklist (including documentation updates, code review process etc.)
- Links to Code of Conduct and LICENSE
Benefits:
- Makes it easier for new contributors to get involved & contribute to project more effectively
- Ensures consistency in contributions
- Aligns with open-source best practices
I’d be happy to draft the initial version of CONTRIBUTING.md and open a PR for review
Right now, the README file in the repository only has basic instructions for how to contribute. These are useful, but they don't cover everything that new contributors need to know. Putting a separate CONTRIBUTING.md file in place would make things more clearer and easier to understand.
Suggested contents for CONTRIBUTING.md:
Benefits:
I’d be happy to draft the initial version of CONTRIBUTING.md and open a PR for review