Skip to main content

Contributing

The following information provides a set of guidelines for contributing to the Sentinel CLI dev repo. Use your best judgment, and, if you see room for improvement, please propose changes to this document.

Contributions come in the form of writing documentation, raising issues / PRs, and any other actions that help develop the Sentinel protocol documentation.

Proposing changes​

To contribute a change proposal, use the following workflow:

  1. Fork the repository.

  2. Add an upstream so that you can update your fork.

  3. Clone your fork to your computer.

  4. Create a branch and name it appropriately.

  5. Work on only one major change in one pull request.

  6. Make sure all tests are passing locally.

  7. Next, rinse and repeat the following:

    • Commit your changes. Write a simple, straightforward commit message. To learn more, see How to Write a Git Commit Message.
    • Push your changes to your remote fork.
    • Create a PR on the Sentinel repository. There should be a PR template to help you do so.
    • Wait for your changes to be reviewed. If you are a maintainer, you can assign your PR to one or more reviewers. If you aren't a maintainer, one of the maintainers will assign a reviewer.
    • After you receive feedback from a reviewer, make the requested changes, commit them to your branch, and push them to your remote fork again.
    • Once approval is given, feel free to squash & merge!