Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 4.09 KB
Raw

Contributing to Open Brewery DB

Welcome to the Open Brewery DB community

Thank you for contributing to Open Brewery DB! It's fellow beer lovers like you that make Open Brewery DB such a great resource. 🍻

Why the guidelines

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

What to contribute

Open Brewery DB is a fully transparent, open source project and we love to receive any contributions from our community — you! There are many ways to contribute, from suggesting brewery updates, writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Open Brewery DB itself.

Responsibilities

  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Code of Conduct.

Here are a couple of helpful tutorials:

Pull Request

After you've created a branch on your fork with your changes, it's time to make a pull request!

Once you’ve submitted a pull request, the collaborators can review your proposed changes and decide whether or not to incorporate (pull in) your changes.

Pull Request Pro Tips

  • Fork the repository and clone it locally. Connect your local repository to the original upstream repository by adding it as a remote. Pull in changes from upstream often so that you stay up to date and so when you submit your pull request, merge conflicts will be less likely. See more detailed instructions here.
  • Create a branch for your edits.
  • Contribute in the style of the project. This makes it easier for the collaborators to merge and for others to understand and maintain in the future.
  • Please try to squash all commits together before opening a pull request, but it's not currently required. If your pull request requires changes upon review, and you're already in the habit, please squash all additional commits as well. This wiki page outlines the squash process.

Open Pull Requests

Once you’ve opened a pull request, a discussion will start around your proposed changes.

Other contributors and users may chime in, but ultimately the decision is made by the collaborators.

During the discussion, you may be asked to make some changes to your pull request.

If so, add more commits to your branch and push them – they will automatically go into the existing pull request!

Opening a pull request will trigger a Github Action build to check the validity of all links in the project. After the build completes, please ensure that the build has passed. If the build did not pass, please view the Github Action log and correct any errors that were found in your contribution.

Thanks for being a part of this project, and we look forward to hearing from you soon! 🍻