Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 3.62 KB
Raw

Contributing to arfpy

We welcome contributions from the community! We greatly appreciate any effort that helps making arfpy a transparent and valuable open source project. This guide is based on this template and explains how you can contribute to arfpy.

A contribution can be one of the following cases:

  1. You have a question;
  2. You think you may have found a bug (including unexpected behavior);
  3. You want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation).

The sections below outline the steps in each case.

You have a question

  1. Browse through the reported issues here to see if someone already filed the same issue;
  2. If your issue search did not yield any relevant results, please open a new issue;
  3. Add a relevant label to your issue, e.g. "Question"

You think you may have found a bug

  1. Browse through the reported issues here to see if someone already filed the same issue;
  2. If your issue search did not yield any relevant results, please open a new issue. Make sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you should include:
    • a reproducible example
    • the SHA hashcode of the commit that is causing your problem;
    • some identifying information (name and version number) for dependencies you're using;
    • information about the operating system;
  3. Add relevant labels to the newly created issue.

You want to make some kind of change to the code base

  1. It may be a good idea to announce your plan to the rest of the community before you start working by opening a new issue
  2. If needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions here and here);
  3. Make sure that all relevant dependencies specified in the requirements.txt are installed; it might be a good idea to use a conda environment at this stage;
  4. Make sure the existing automated tests run. To do so, navigate to the tests folder and run python3 test.py in your command line;
  5. Add your own tests (if necessary) to the tests folder;
  6. Update or expand the documentation in the docs folder;
  7. Push your feature branch to (your fork of) the repository on GitHub;
  8. Create a pull request

In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request! Please try to tick off as many points as you can (this helps making the process faster, because the arfpy package maintainers may be quite busy) and submit the pull request. We'll do our best to help, but keep in mind that you might be asked to append additional commits to your pull request.