Skip to content

Latest commit

 

History

History
94 lines (62 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

94 lines (62 loc) · 2.65 KB
Raw

Contributing Guidelines

This project is Apache licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.

In order to show your agreement with the DCO you should include at the end of commit message, the following line: Signed-off-by: John Doe <john.doe@example.com>, using your real name.

This can be done easily using the -s flag on the git commit.

Support Channels

The official support channels, for both users and contributors, are:

How to Contribute

Pull Requests (PRs) are the main and exclusive way to contribute to the official escalate-permissions project.

Setup

Fork, then clone the repository:

git clone git@github.com:your_github_username/escalate-permissions.git
cd escalate-permissions
git remote add upstream https://github.com/voi-oss/escalate-permissions.git
git fetch upstream

Install escalate-permissions dependencies:

make vendor

Make sure that the tests and the linters pass:

make lint
make test

Making Changes

Start by creating a new branch for your changes:

git checkout master
git fetch upstream
git rebase upstream/master
git checkout -b new-feature

Make your changes, then ensure that make lint and make test still pass. If you're satisfied with your changes, push them to your fork.

git push origin new-feature

Then use the GitHub UI to open a pull request.

At this point, you're waiting on us to review your changes. We try to respond to issues and pull requests within a few business days, and we may suggest some improvements or alternatives. Once your changes are approved, one of the project maintainers will merge them.

We're much more likely to approve your changes if you:

  • Add tests for new functionality.
  • Write a good commit message.
  • Maintain backward compatibility.