Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.53 KB

Contributing.md

File metadata and controls

46 lines (34 loc) · 2.53 KB
Raw

Contributing

Communication

Building brewing software is hard and complicated. It's a confusing domain to work in when you get down to the science of how ingredients affect the outcome. To make this web service as good as possible, we need to actively communicate. I strongly encourage anyone interested in working on this project to join the slack team. Email me, Michael Washburn Jr for an invite. My email can be found on my github profile.

Getting Started

If you're interested in working on the BrewCenterAPI, you can start by digging through the issues and searching for ones with the "Beginner" label. Furthermore, there's always several beginner tasks that are constantly in need of being done which aren't in the issues. Here are some examples of great tasks you can do to get started: pull the repo and run the tests, run the code through a linter like pylint and fix the errors, write additional unit tests, write API level tests (HTTP requests hitting the endpoints), add comments to confusing code after you think you understand it, look for duplicate code and extract it into a common function/class.

PRs

I try to review PRs at least within 2 days. I will try my best to thoroughly review PRs and leave good feedback. I always test the PRs before merging. If you want your PR to be merged in fast, please make sure to do the following:

  1. Run the unit tests
  2. Write unit tests for functionality you introduced
  3. Run your code through a linter like pylint
  4. Thoroughly test your PR
  5. Make sure your PR is up-to-date with master.

I will help you along the way by offering feedback. I will not, however, take half-completed PRs and finish them myself. The PR is yours and yours alone. If it goes without being worked for 20 days or so, it will be closed without merging.

Installation

First, download the latest stable release of Python 3.

Install the requirements using pip.

pip install -r requirements.txt

Then, copy brewcenter_api/example.settings.py to brewcenter_api/settings.py and modify to your needs.

To create your database, execute the following command:

python manage.py migrate

To update your data by mining known sources, execute the following command:

python manage.py updatedata

To run the app, execute the following command:

python manage.py runserver

Testing

To run the tests, cd to the same directory as the manage.py file, then run python manage.py test brew_data.tests.