Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

53 lines (40 loc) · 3.62 KB
Raw

Contributing guidelines

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

The following is a set of guidelines for contributing to Gradsflow and its packages, which are hosted in the GradsFlow Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

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);
  4. you want to make a new release of the code base.

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 or check out Docs.
  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.
  4. You can join our Slack group as well.

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) announce your plan to the rest of the community before you start working. This announcement should be in the form of a (new) issue;
  2. (important) wait until some kind of consensus is reached about your idea being a good idea;
  3. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions here and here);
  4. make sure the existing tests still work by running pytest;
  5. add your own tests (if necessary);
  6. update or expand the documentation;
  7. update the docs/CHANGELOG.md file with change;
  8. push your feature branch to (your fork of) the https://github.com/gradsflow/gradsflow repository on GitHub;
  9. 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.