This repository has been archived by the owner on Oct 12, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove references to Phabricator in CONTRIBUTING.md.
- Loading branch information
Showing
1 changed file
with
31 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,57 @@ | ||
| # How to contribute # | ||
| # How to contribute | ||
|
|
||
| We'd love to accept your patches and contributions to this project. There are | ||
| a just a few small guidelines you need to follow. | ||
| We'd love to accept your patches and contributions to this project. There are a | ||
| just a few small guidelines you need to follow. | ||
|
|
||
| ## Contributor License Agreement | ||
|
|
||
| ## Contributor License Agreement ## | ||
| Contributions to any Google project must be accompanied by a Contributor License | ||
| Agreement. This is not a copyright **assignment**, it simply gives Google | ||
| permission to use and redistribute your contributions as part of the project. | ||
|
|
||
| Contributions to any Google project must be accompanied by a Contributor | ||
| License Agreement. This is not a copyright **assignment**, it simply gives | ||
| Google permission to use and redistribute your contributions as part of the | ||
| project. | ||
|
|
||
| * If you are an individual writing original source code and you're sure you | ||
| * If you are an individual writing original source code and you're sure you | ||
| own the intellectual property, then you'll need to sign an [individual | ||
| CLA][]. | ||
|
|
||
| * If you work for a company that wants to allow you to contribute your work, | ||
| * If you work for a company that wants to allow you to contribute your work, | ||
| then you'll need to sign a [corporate CLA][]. | ||
|
|
||
| You generally only need to submit a CLA once, so if you've already submitted | ||
| one (even if it was for a different project), you probably don't need to do it | ||
| You generally only need to submit a CLA once, so if you've already submitted one | ||
| (even if it was for a different project), you probably don't need to do it | ||
| again. | ||
|
|
||
| [individual CLA]: https://developers.google.com/open-source/cla/individual | ||
| [corporate CLA]: https://developers.google.com/open-source/cla/corporate | ||
|
|
||
| Once your CLA is submitted (or if you already submitted one for | ||
| another Google project), make a commit adding yourself to the | ||
| [AUTHORS][] and [CONTRIBUTORS][] files. This commit can be part | ||
| of your first patch. | ||
| Once your CLA is submitted (or if you already submitted one for another Google | ||
| project), make a commit adding yourself to the [AUTHORS][] and [CONTRIBUTORS][] | ||
| files. This commit can be part of your first patch. | ||
|
|
||
| [AUTHORS]: AUTHORS | ||
| [CONTRIBUTORS]: CONTRIBUTORS | ||
|
|
||
| ## Submitting a patch | ||
|
|
||
| ## Submitting a patch ## | ||
|
|
||
| 1. It's generally best to start by opening a new issue describing the bug or | ||
| feature you're intending to fix. Even if you think it's relatively minor, | ||
| it's helpful to know what people are working on. Mention in the initial | ||
| issue that you are planning to work on that bug or feature so that it can | ||
| be assigned to you. | ||
|
|
||
| 2. Follow the normal process of [forking][] the project, and setup a new | ||
| branch to work in. It's important that each group of changes be done in | ||
| separate branches in order to ensure that a pull request only includes the | ||
| commits related to that bug or feature. | ||
|
|
||
| 3. Do your best to have [well-formed commit messages][] for each change. | ||
| This provides consistency throughout the project, and ensures that commit | ||
| messages are able to be formatted properly by various git tools. | ||
|
|
||
| 4. If not already done, setup a user in the [Phabricator instance][] for the | ||
| project, by visiting the instance and waiting for approval. | ||
|
|
||
| 5. From your branch, create a patch for review using [arc][]: | ||
|
|
||
| $ arc diff master | ||
|
|
||
| Pick reviewers from the list of users in the [Phabricator instance][]. | ||
| 1. It's generally best to start by opening a new issue describing the bug or | ||
| feature you're intending to fix. Even if you think it's relatively minor, | ||
| it's helpful to know what people are working on. Mention in the initial | ||
| issue that you are planning to work on that bug or feature so that it can be | ||
| assigned to you. | ||
|
|
||
| 6. To upload change in response to review comments, if any, use the same command. | ||
| 2. Follow the normal process of [forking][] the project, and setup a new branch | ||
| to work in. It's important that each group of changes be done in separate | ||
| branches in order to ensure that a pull request only includes the commits | ||
| related to that bug or feature. | ||
|
|
||
| 7. Finally, after the change is approved, push to master using [arc][]: | ||
| 3. Do your best to have [well-formed commit messages][] for each change. This | ||
| provides consistency throughout the project, and ensures that commit | ||
| messages are able to be formatted properly by various git tools. | ||
|
|
||
| $ arc land | ||
| 4. [Create a pull request][] for the project | ||
| https://github.com/google/shipshape. A team member will review the patch and | ||
| let you know if any changes are needed before merging into master. | ||
|
|
||
| [forking]: https://help.github.com/articles/fork-a-repo | ||
| [well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
| [arc]: https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start | ||
| [Phabricator instance]: https://phabricator-dot-shipshapecode.appspot.com/ | ||
| [Create a pull request]: https://help.github.com/articles/creating-a-pull-request/ |