Skip to content

Commit

Permalink
Replace CONTRIBUTING.md (sigstore#145)
Browse files Browse the repository at this point in the history
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
  • Loading branch information
mihaimaruseac authored Mar 20, 2024
1 parent 21ffb01 commit 9bd60b4
Showing 1 changed file with 107 additions and 23 deletions.
130 changes: 107 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,116 @@
# Contributing

Want to contribute? Great! First, read this page (including the small print at
the end).
When contributing to a repository in the Sigstore organization, please first discuss the change you wish
to make via an issue in the repository.

### Before you contribute
## Pull Request Process

Before we can use your code, you must sign the [Google Individual Contributor
License Agreement](https://cla.developers.google.com/about/google-individual)
(CLA), which you can do online. The CLA is necessary mainly because you own the
copyright to your changes, even after your contribution becomes part of our
codebase, so we need your permission to use and distribute your code. We also
need to be sure of various other things: for instance that you'll tell us if you
know that your code infringes on other people's patents. You don't have to sign
the CLA until after you've submitted your code for review and a member has
approved it, but you must do it before we can put your code into our codebase.
1. Create an issue in the repository outlining the fix or feature.
2. Fork the repository to your own GitHub account and clone it locally.
3. Complete and test the change.
4. If relevant, update documentation with details of the change. This includes updates to an API, new environment
variables, exposed ports, useful file locations, CLI parameters and
new or changed configuration values.
5. Correctly format your commit message - See [Commit Messages](#commit-message-guidelines)
below.
6. Sign off your commit.
7. Ensure that CI passes. If it fails, fix the failures.
8. Every pull request requires a review from the Sigstore subprojects MAINTAINERS.
9. If your pull request consists of more than one commit, please squash your
commits as described in [Squash Commits](#squash-commits), or the commits
will be squashed on merge.

Before you start working on a larger contribution, you should get in touch with
us first through the issue tracker with your idea so that we can help out and
possibly guide you. Coordinating up front makes it much easier to avoid
frustration later on.
## Commit Message Guidelines

### Code reviews
We follow the commit formatting recommendations found on [Chris Beams' How to Write a Git Commit Message article](https://chris.beams.io/posts/git-commit/).

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose.
Well formed commit messages not only help reviewers understand the nature of
the Pull Request, but also assists the release process where commit messages
are used to generate release notes.

### The small print
A good example of a commit message would be as follows:

Contributions made by corporations are covered by a different agreement than the
one above, the [Software Grant and Corporate Contributor License
Agreement](https://cla.developers.google.com/about/google-corporate).
```
Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded
by a single space, with blank lines in between, but conventions
vary here
If you use an issue tracker, put references to them at the bottom,
like this:
Resolves: #123
See also: #456, #789
```

Note the `Resolves #123` tag, this references the issue raised and allows us to
ensure issues are associated and closed when a pull request is merged.

Please refer to [the github help page on message types](https://help.github.com/articles/closing-issues-using-keywords/)
for a complete list of issue references.

## Squash Commits

Should your pull request consist of more than one commit (perhaps due to
a change being requested during the review cycle), please perform a git squash
once a reviewer has approved your pull request.

A squash can be performed as follows. Let's say you have the following commits:

initial commit
second commit
final commit

Run the command below with the number set to the total commits you wish to
squash (in our case 3 commits):

git rebase -i HEAD~3

You default text editor will then open up and you will see the following::

pick eb36612 initial commit
pick 9ac8968 second commit
pick a760569 final commit

# Rebase eb1429f..a760569 onto eb1429f (3 commands)

We want to rebase on top of our first commit, so we change the other two commits
to `squash`:

pick eb36612 initial commit
squash 9ac8968 second commit
squash a760569 final commit

After this, should you wish to update your commit message to better summarise
all of your pull request, run:

git commit --amend

You will then need to force push (assuming your initial commit(s) were posted
to github):

git push origin your-branch --force

Alternatively, a core member can squash your commits within Github.

## Code of Conduct

Sigstore adheres to and enforces the [Contributor Covenant](http://contributor-covenant.org/version/1/4/) Code of Conduct.
Please take a moment to read the [CODE_OF_CONDUCT.md](https://github.com/sigstore/community/blob/main/CODE_OF_CONDUCT.md) document.

0 comments on commit 9bd60b4

Please sign in to comment.