Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.38 KB

Contributing

Contributions to this project are released to the public under the project's open source license.

Everyone is welcome to contribute to Recipe App. Contributing doesn’t just mean submitting pull requests—there are many different ways for you to get involved, including answering questions, reporting or triaging issues, and participating in discussions about the project.

Before contributing, please read the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

I love pull requests. Here's a quick guide:

  1. Check for existing issues to avoid duplicates.
  2. Fork the repo and clone it locally.
  3. Create a new branch for your contribution.
  4. Make your changes and ensure tests pass.
  5. Push to your fork and submit a pull request.

Some tips to increase the chance of your pull request being accepted:

Make sure the tests pass. Update documentation, code comments, and example code as needed. Include relevant information to reproduce bugs or explain new features.

Pull Request Reviews & Releasing

Releases are managed using semantic-release. Once merged into the main branch, semantic-release will automatically release a new version based on the commit messages of the pull request. Follow the commit message conventions:

  • fix: ... for bug fixes
  • feat: ... for new features
  • BREAKING CHANGE: ... in the commit body for breaking changes