Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 1.82 KB
Raw

Contributing to clairBuoyant

Here are the guidelines we'd like you to follow:

Got a Question?

Create an issue with your questions.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue here or submit a Pull Request with a fix.

See below for additional guidelines.

Want a Feature?

You can request a new feature by submitting a feature request here.

Submission Guidelines

Submitting a Pull Request

  • 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.

  • Build your changes locally to ensure all the tests pass:

    poetry run test

  • Push your branch to GitHub:

    git push -u origin my-local-branch

  • Keep your branch updated with main:

    git rebase main

  • If we suggest changes then:

    • Make the required updates.

    • Re-run the test suite 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 origin my-local-branch -f

      Note: -i is an optional flag that generates a list of commits that are about to rebased.