Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 1.77 KB

Contributing to Sardines Are Good

Thank you for considering contributing to Sardines Are Good! Before you start, please take a moment to read this guide.

How to contribute

Here are some ways you can contribute to the project:

  • Report a bug
  • Suggest a new feature
  • Improve documentation
  • Fix a bug or implement a new feature

Reporting bugs and suggesting features

If you encounter a bug or have an idea for a new feature, please open an issue on GitHub. Please be as descriptive as possible and provide any relevant information such as error messages, steps to reproduce the issue, and screenshots.

Improving documentation

If you notice any errors or inconsistencies in the documentation, or would like to add new content, please feel free to open a pull request with your changes.

Fixing bugs and implementing features

If you'd like to contribute code to the project, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them with a clear message.
  5. Push your changes to your fork on GitHub.
  6. Open a pull request with a description of your changes.

Code style

Please follow the existing code style and conventions when making changes. If you're unsure about anything, please feel free to ask.

Testing

Please ensure that your changes are covered by tests and that all tests pass before opening a pull request.

Code of conduct

Please note that Sardines Are Good has a code of conduct. By participating in this project, you agree to abide by its terms.

License

Sardines Are Good is licensed under the GNU General Public License v3.0. By contributing to this project, you agree to license your contributions under the same license.