Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 4.34 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 4.34 KB
Raw

Contributing guidelines

We welcome any kind of contribution to our software, from simple comment or question to a full fledged pull request. Please read and follow our Code of Conduct.

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. use the search functionality here to see if someone already filed the same issue;
  2. if your issue search did not yield any relevant results, make a new issue;
  3. apply the "Question" label; apply other labels when relevant.

You think you may have found a bug

  1. use the search functionality here to see if someone already filed the same issue;
  2. if your issue search did not yield any relevant results, make a new issue, making 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 may want to include:
    • 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. apply relevant labels to the newly created issue.

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

  1. (important) this repository implements the best practices we recommend in the Python chapter of the Guide. Check that your planned contribution is in line with what is recommended there. If not, please contribute to the guide instead / as well, or at least create an issue there.
  2. (important) announce your plan to the rest of the community before you start working. This announcement should be in the form of a (new) issue;
  3. (important) wait until some kind of consensus is reached about your idea being a good idea;
  4. 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);
  5. install dependencies (see the development documentation);
  6. make sure the existing tests still work by running pytest. If project tests fail use pytest --keep-baked-projects to keep generated project files in /tmp/pytest-* and investigate;
  7. add your own tests (if necessary);
  8. update or expand the documentation;
  9. update the CHANGELOG.md file with your change;
  10. push your feature branch to (your fork of) the Python Template repository on GitHub;
  11. create the pull request, e.g. following the instructions here.

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; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.

You want to make a new release of the code base

To create a release you need write permission on the repository.

  1. Check the author list in CITATION.cff
  2. Update the version number in setup.cfg and CITATION.cff
  3. Update the CHANGELOG.md to include changes made
  4. Go to the GitHub release page
  5. Press draft a new release button
  6. Fill version, title and description field
  7. Press the Publish Release button

Also a Zenodo entry will be made for the release with its own DOI.