mirrors/nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus synced 2026-01-05 04:56:03 +00:00
Code Issues Releases Wiki Activity

Add more information on pull request process to CONTRIBUTING.md

Browse Source 
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=138901852
This commit is contained in:
mcilwain
2016-11-11 11:51:24 -08:00
committed by Ben McIlwain
parent d5104df453
commit 0af09d264f
1 changed files with 35 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
CONTRIBUTING.md
View File

@@ -1,27 +1,39 @@
Want to contribute? Great! First, read this page (including the small print at the end).
Want to contribute? Great! First, read this page (including the small print at
the end).
### Before you contribute
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.
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.
## Before you contribute
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 accept your code into our codebase.
For larger changes, it is recommended that you first propose your idea and
gather consensus on the [nomulus-discuss mailing
list](https://groups.google.com/forum/#!forum/nomulus-discuss).
## Code reviews and pull requests
### Code reviews
All submissions, including submissions by project members, require review. We
use Github pull requests for this purpose.
use GitHub [pull
requests](https://help.github.com/articles/about-pull-requests/) for this
purpose. Because GitHub is not yet the authoritative source of truth for the
Nomulus codebase, pull requests are closed (*not* merged) upon approval, and a
commit with full attribution to the author will be included in the next regular
sync of code to GitHub. Owing to this mechanism, every pull request ultimately
results in a single commit in the repository, so it is recommended that pull
requests contain only a single commit to minimize possible merge headaches for
you.
### The small print
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).
## The small print
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).