oss-slu / shelter_volunteers

MIT License
3 stars 4 forks source link

Establish Contribution Guide and Coding Standards for External Contributors #95

Open SiriChandanaGarimella opened 7 months ago

SiriChandanaGarimella commented 7 months ago

Is your feature request related to a problem? Please describe. As this is an OSS project, we may start receiving contributions from external developers. To ensure a smooth and consistent contribution process, as well as maintain code quality and adhere to best practices, we need to create a contribution guide and define coding standards for external contributors.

Describe the solution you'd like Contribution Guide: The contribution guide should provide clear instructions and guidelines for external contributors, covering the following aspects:

  1. Instructions on how to set up the development environment, install dependencies, and run the project locally.
  2. Steps for identifying issues to work on, creating a feature branch, making changes, testing, and submitting a pull request.
  3. Code review process.
  4. Instructions on how to report bugs or request new features etc.

Coding Standards: In addition to the contribution guide, we need to define and document coding standards:

  1. Code formatting, code style, and linting.
  2. Guidelines for writing unit tests, integration tests, and guidelines for test coverage expectations.
  3. Inline code comments etc