Skip to content

Latest commit

 

History

History
115 lines (64 loc) · 6.98 KB

CONTRIBUTING.md

File metadata and controls

115 lines (64 loc) · 6.98 KB
Raw

Contributing

👍🎉 First off, thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

What Should I Know Before I Get Started?

If you're new to GitHub and working with open source repositories, this section will be helpful. Otherwise, you can skip to learning how to set up your dev environment.

Code of Conduct

This project adheres to the Contributor Covenant. By participating, you are expected to uphold this code.

Please report unacceptable behavior to one of the Code Owners.

How Do I Start Contributing?

The below workflow is designed to help you begin your first contribution journey. It will guide you through creating and picking up issues, working through them, having your work reviewed, and then merging.

Help on open source projects is always welcome and there is always something that can be improved. For example, documentation (like the text you are reading now) can always use improvement, code can always be clarified, variables or functions can always be renamed or commented on, and there is always a need for more test coverage. If you see something that you think should be fixed, take ownership! Here is how you get started:

How Can I Contribute?

When contributing, it's useful to start by looking at issues. After picking up an issue, writing code, or updating a document, make a pull request and your work will be reviewed and merged. If you're adding a new feature, it's best to write an issue first to discuss it with maintainers first.

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report ✏️, reproduce the behavior 💻, and find related reports 🔎.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues using the Bug Report template. Create an issue on that and provide the information suggested in the bug report issue template.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features, tools, and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion ✏️ and find related suggestions 🔎

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues using the Feature Request template. Create an issue and provide the information suggested in the feature requests or user story issue template.

How Do I Submit A (Good) Improvement Item?

Improvements to existing functionality are tracked as GitHub issues using the User Story template. Create an issue and provide the information suggested in the feature requests or user story issue template.

Development

Set up your dev environment

Using Docker

The easiest way to get up and running is to use the dockerized development environment which you can launch using:

make develop

Within the develop shell, any of the make targets that do not require docker can be run directly. The shell has the local files mounted, so changes to the files on your host machine will be reflected when commands are run in the develop shell.

Locally

You can also develop locally using standard python development practices. You'll need to install the dependencies for the unit tests. It is recommended that you do this in a virtual environment such as conda or pyenv so that you avoid version conflicts in a shared global dependency set.

pip install -r requirements_test.txt

Run unit tests

Running the tests is as simple as:

make test

If you want to use the full set of pytest CLI arguments, you can run the scripts/run_tests.sh script directly with any arguments added to the command.

Code formatting

This project uses pre-commit to enforce coding style using black. To set up pre-commit locally, you can:

pip install pre-commit

Coding style is enforced by the CI tests, so if not installed locally, your PR will fail until formatting has been applied.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these issues:

  • Issues with the good first issue label - these should only require a few lines of code and are good targets if you're just starting contributing.
  • Issues with the help wanted label - these range from simple to more complex, but are generally things we want but can't get to in a short time frame.

How to contribute

To contribute to this repo, you'll use the Fork and Pull model common in many open source repositories. For details on this process, watch how to contribute.

When ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard github pull request process. Follow the template to provide details about your pull request to the maintainers.

Before sending pull requests, make sure your changes pass tests.

Code Review

Once you've created a pull request, maintainers will review your code and likely make suggestions to fix before merging. It will be easier for your pull request to receive reviews if you consider the criteria the reviewers follow while working. Remember to:

  • Run tests locally and ensure they pass
  • Follow the project coding conventions
  • Write detailed commit messages
  • Break large changes into a logical series of smaller patches, which are easy to understand individually and combine to solve a broader issue