Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

72 lines (46 loc) · 3.47 KB
Raw

Contributing to automatminer

We love your input! We want to make contributing to automatminer as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing or implementing new features
  • Becoming a maintainer

Reporting bugs, getting help, and discussion

At any time, feel free to start a thread on the automatminer Discourse forum.

If you are making a bug report, incorporate as many elements of the following as possible to ensure a timely response and avoid the need for followups:

  • A quick summary and/or background
  • Steps to reproduce - be specific! Provide sample code.
  • What you expected would happen, compared to what actually happens
  • The full stack trace of any errors you encounter
  • Notes (possibly including why you think this might be happening, or steps you tried that didn't work)

We love thorough bug reports as this means the development team can make quick and meaningful fixes. When we confirm your bug report, we'll move it to the GitHub issues where its progress can be further tracked.

Contributing code modifications or additions through GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase. Follow the GitHub flow for more information on this procedure.

The basic procedure for making a PR is:

  • Fork the repo on GitHub and clone it to your machine.

    git clone https://github.com/<your_github_name>/automatminer && cd automatminer

  • Install both regular and development dependencies and setup the git pre-commit hook.

    pip install -r requirements.txt requirement && pre-commit install

    This step is important as your changes may otherwise contain style violations that will throw errors when running our CI on your pull request.

  • Test your changes by running our full test suite

    python -m unittest

  • Commit your improvements and push to your GitHub fork.

  • When you're finished, go to your fork and make a pull request. It will automatically update if you need to make further changes.

How to Make a Great Pull Request

We have a few tips for writing good PRs that are accepted into the main repo:

  • Use the Google Code style for all of your code. Find an example here.
  • Your code should have (4) spaces instead of tabs.
  • If needed, update the documentation.
  • Write tests for new features! Good tests are 100%, absolutely necessary for good code. We use the Python unittest framework -- see some of the other tests in this repo for examples, or review the Hitchhiker's guide to python for some good resources on writing good tests.
  • Understand your contributions will fall under the same license as this repo.

When you submit your PR, our CI service will automatically run your tests. We welcome good discussion on the best ways to write your code, and the comments on your PR are an excellent area for discussion.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft, as well as briandk's contribution template.