Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating commit instructions. 

Signed-off-by: WalkerWatch <ctwalker@gmail.com>
This commit is contained in:
WalkerWatch 2017-03-09 15:29:48 -05:00
parent e7de3ee662
commit c2887d0b14
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
jetty-documentation/src/main/asciidoc/reference/contributing/patches.adoc
View File

@ -31,10 +31,10 @@ The following is the general process by which we operate.
Not everything is specifically relevant since we are at GitHub but the crux of things are detailed there. Not everything is specifically relevant since we are at GitHub but the crux of things are detailed there.
The CLA is *critically* important to the process. The ECA is *critically* important to the process.
[[contributing-cla]] [[contributing-eca]]
==== Sign a CLA ==== Sign an Eclipse Contributor Agreement (ECA)
The Eclipse Foundation has a strong Intellectual Property policy which tracks contributions in detail to ensure that: The Eclipse Foundation has a strong Intellectual Property policy which tracks contributions in detail to ensure that:
@ -42,12 +42,12 @@ The Eclipse Foundation has a strong Intellectual Property policy which tracks co
2. Does the contributor have the rights to contribute this content to Eclipse? 2. Does the contributor have the rights to contribute this content to Eclipse?
3. Is the contribution under the project’s license(s) (e.g. EPL) 3. Is the contribution under the project’s license(s) (e.g. EPL)
A contributor needs to e-sign a Contributor Licence Agreement (for more explanation see the http://www.eclipse.org/legal/clafaq.php[Eclipse CLA FAQ] ) regardless of how their contribution patch is provided. A contributor needs to e-sign a Eclipse Contributor Agreement (for more explanation see the http://www.eclipse.org/legal/ecafaq.php[Eclipse ECA FAQ] ) regardless of how their contribution patch is provided.
You can familiarize yourself with the Eclipse wiki page at http://wiki.eclipse.org/Development_Resources/Contributing_via_Git[Contributing via Git]. You can familiarize yourself with the Eclipse wiki page at http://wiki.eclipse.org/Development_Resources/Contributing_via_Git[Contributing via Git].
In order to have a pull request accepted by any Eclipse project you must complete this agreement. In order to have a pull request accepted by any Eclipse project you *must* complete this agreement.
____ ____
[TIP] [TIP]
Log into the https://projects.eclipse.org/user/login/sso[Eclipse projects forge] (you will need to create an account with the Eclipse Foundation if you have not already done so); click on "Contributor License Agreement"; and Complete the form. Log into the https://www.eclipse.org[Eclipse home page] (you will need to create an account with the Eclipse Foundation if you have not already done so), click on "Eclipse ECA", and complete the form.
Be sure to use the _same email address_ when you create any Git commit records. Be sure to use the _same email address_ when you create any Git commit records.
____ ____
@ -60,13 +60,13 @@ Check out the following link:https://help.github.com/articles/setting-your-email
[[contributing-making-the-commit]] [[contributing-making-the-commit]]
==== Making the Commit ==== Making the Commit
When making the commit for the pull request it is _vital_ that you "sign-off" on the commit using "git commit -s" option. When making the commit for the pull request it is _vital_ that you "sign-off" on the commit using `git commit -s` option.
Without this sign-off, your patch cannot be applied to the Jetty repository because it will be rejected. Without this sign-off, your patch cannot be applied to the Jetty repository because it will be rejected.
You can check out the link:https://help.github.com/articles/signing-tags-using-gpg[guide at Github] for more information. You can check out the link:https://help.github.com/articles/signing-tags-using-gpg[guide at Github] for more information.
____ ____
[TIP] [TIP]
One way to think of this is that when you sign the CLA you are indicating that you are free to contribute to eclipse, but that doesn't mean everything you ever do can be contributed. One way to think of this is that when you sign the ECA you are indicating that you are free to contribute to eclipse, but that doesn't mean everything you ever do can be contributed.
Using the commit signing mechanism indicates that your commit is under the auspices of your agreement. Using the commit signing mechanism indicates that your commit is under the auspices of your agreement.
____ ____
@ -74,9 +74,10 @@ If a pull request is for a particular issue in our repository then the format of
The message should follow the form "Issue #123 <description of the commit>". The message should follow the form "Issue #123 <description of the commit>".
When the Jetty project runs releases we have an automated process that scans for commits with this format for inclusion in our VERSION.txt file. When the Jetty project runs releases we have an automated process that scans for commits with this format for inclusion in our VERSION.txt file.
____ [source, screen]
----
> git commit -s -m "Issue #123 resolving the issue by adding widget" > git commit -s -m "Issue #123 resolving the issue by adding widget"
____ ----
[[contributing-the-pull-request]] [[contributing-the-pull-request]]
==== The Pull Request ==== The Pull Request
@ -87,10 +88,11 @@ Pull requests are very much a GitHub process so best link:https://help.github.co
==== Our Policies ==== Our Policies
We wholeheartedly welcome contributions to Jetty and will do our best to process them in a timely fashion. We wholeheartedly welcome contributions to Jetty and will do our best to process them in a timely fashion.
While not every contribution will be accepted as is our commitment is to work with interested parties on the things they care about. While not every contribution will be accepted, our commitment is to work with interested parties on the things they care about.
With that in mind, short of some simple contributions we can only handle pull requests with actively engaged parties. With that in mind, we can only handle pull requests with actively engaged parties.
We reserve the right to abandon pull requests whose authors do no respond in a timely fashion. We reserve the right to abandon pull requests whose authors do no respond in a timely fashion.
We will generally adhere to the following time frames for contributions.
We will generally adhere to the following time frames for contributions:
* Invalid Pull Requests - 1 week * Invalid Pull Requests - 1 week
** These pull requests do not follow the contribution requirements for some reason, be it missing contributor agreement or the wrong email. ** These pull requests do not follow the contribution requirements for some reason, be it missing contributor agreement or the wrong email.