CONTRIBUTING.md

1. Fork the repo on GitHub (if you haven't already)

2. Clone your fork fork locally:

3. Create a branch for local development:

   git checkout -b name-of-bugfix-or-feature

4. We follow the style guide published on the course Nexus.

5. Now make the appropriate changes locally.

6. Auto-format and lint your code using YAPF, isort, and pylint.

7. Add your change to the changelog for the current version in HISTORY.md.

8. Commit the changes and push the branch to GitHub:

9. Submit a pull request through the GitHub web interface.

A rough checklist you should attach to every pull request:

• I have read the guidelines in CONTRIBUTING.md
• I have formatted my code using yapf
• I have linted my code with pylint
• I have added a one-line description of my change to the changelog in HISTORY.md
• This PR is ready