CONTRIBUTING.md

Contributing to Open Brewery DB

Welcome to the Open Brewery DB community

Thank you for considering 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 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:

• Make a Pull Request
• First Timers Only
• How to Contribute to an Open Source Project on GitHub.