Thank you for considering contributing to Peppers & Plates! We appreciate your efforts and want to make it as easy as possible for you to contribute. This guide provides guidelines on how to contribute, what you need to know, and the process for submitting changes.
Our project follows a Code of Conduct. Please read and adhere to it while contributing.
- If you find a bug or have a suggestion, create an issue in the issue tracker.
- Use a descriptive title and provide as much detail as possible.
- For significant changes, open an issue to discuss your proposal before submitting a pull request.
- Describe the proposed change and its impact.
- Fork the repository and create a branch for your change.
- Ensure your code follows the Coding Standards.
- Test your code before submitting.
- Create a pull request with a clear description of your change.
- Reference the related issue(s) if applicable.
- Follow the language-specific coding guidelines.
- Maintain consistent style and formatting.
- Provide instructions for setting up the development environment, including dependencies and tools.
- Describe how to build and run the project locally.
- Describe the testing framework and how to run tests.
- Ensure all tests pass before submitting a pull request.
This project is licensed under the [LICENSE_NAME] license. See LICENSE.md for details.