Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.79 KB
Raw

Contributors Guide

Are you interested in helping out?

Have a few minutes to tackle an issue?

In this guide we will get you setup into contributing to our project!

Setting up your development environment

We recommend using the conda package manager for your environments.

Our recommended setup for contributing is:

  1. Install mambaforge on your system. You may have to restart your prompt for the remaining steps to work.

  2. Now, with a local clone, of your fork you can create a development environment with:

    mamba env create -f reqs/base.yml
mamba env update -f reqs/dev.yml
mamba activate xpublish-intake
pip install -e .

  3. Tests can be run locally by running the pytest command from the cloned repository root.

  4. The changes should be made via GitHub pull requests against the main branch.

More Questions?

If you're stuck somewhere or are interested in being a part of the community in other ways, feel free to contact us!

Further Reading

There are a ton of great resources out there on contributing to open source and on the importance of writing tested and maintainable software.

Working on your first Pull Request? You can learn how from this video series How to Contribute to an Open Source Project on GitHub, Aaron Meurer's tutorial on the git workflow, or the guide “How to Contribute to Open Source".