Skip to content

Latest commit

 

History

History
128 lines (86 loc) · 4.44 KB

CONTRIBUTING.md

File metadata and controls

128 lines (86 loc) · 4.44 KB
Raw

Contributing to dr-utils

We would love for you to contribute to dr-utils and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Got a Question or Problem?

You can create a new discussion for that.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by opening a new discussion to our GitHub Repository. If you would like to implement a new feature, please open a new discussion with a proposal for your work first, to be sure that we can use it.

Please consider what kind of change it is:

  • For a Major Feature, first open a discussion and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. A GitHub Issue can then later be created from this discussion, meaning it will be in the project's Roadmap.
  • Small Features can be crafted and directly submitted as a Pull Request.

Submission Guidelines

Submitting an Issue or opening new Discussion

Before you submit a new issue, or open a new discussion, please search the issue/discussion tracker first; it is possible that one already exist for your inquiry and solutions already exist or were implemented

For facilitating bug reproduction for future fixes, please provide a minimal reproduction scenario using a repository or a Gist. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:

  • Version of dr-utils used
  • 3rd-party libraries and their versions
  • and most importantly: a use-case that fails

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. Fork the Maikuh/dr-utils repo.

  3. Make your changes in a new git branch:

    git checkout -b my-fix-branch main

  4. Create your patch, including appropriate test cases.

  5. Run the full dr-utils test suite and ensure that all tests pass.

  6. Commit your changes using a descriptive commit message

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  7. Push your branch to GitHub:

    git push origin my-fix-branch

  8. In GitHub, send a pull request to dr-utils:main.

  • If we suggest changes then:

    • Make the required updates.

    • Re-run the dr-utils test suites to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase main -i
git push -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin -D my-fix-branch

  • Check out the main branch:

    git checkout main -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your main with the latest upstream version:

    git pull --ff upstream main

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working: