You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by ri...@apache.org on 2016/02/09 15:42:23 UTC
[2/7] brooklyn-docs git commit: minor other doc tidies
minor other doc tidies
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/92721a76
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/92721a76
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/92721a76
Branch: refs/heads/master
Commit: 92721a76c5df347a79ef1b4dd2ccbaa80823954b
Parents: 7bbad59
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Feb 8 16:12:40 2016 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Feb 8 16:13:09 2016 +0000
----------------------------------------------------------------------
website/developers/how-to-contribute.md | 41 +++++++++++++++-------------
website/developers/links.md | 9 +++---
2 files changed, 26 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/92721a76/website/developers/how-to-contribute.md
----------------------------------------------------------------------
diff --git a/website/developers/how-to-contribute.md b/website/developers/how-to-contribute.md
index 551c486..277b29d 100644
--- a/website/developers/how-to-contribute.md
+++ b/website/developers/how-to-contribute.md
@@ -27,18 +27,17 @@ process of making contributions to the Apache Brooklyn code base.
</div>
</div>
-## Contributor License Agreement
+
+### Contributor License Agreement
Apache Brooklyn is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). All
contributions will be under this license, so please read and understand this license before contributing.
-For all but the most trivial patches, you are required to file a Contributor License Agreement with the Apache
+For all but the most trivial patches, **we need a Contributor License Agreement for you** on file with the Apache
Software Foundation. Please read the [guide to CLAs](https://www.apache.org/licenses/#clas) to find out how to file a
CLA with the Foundation.
-## Before You Start
-
### Join the Community
If it's your first contribution or it's a particularly big or complex contribution, things typically go much more
@@ -55,7 +54,7 @@ for your feature request or fix. For small changes this isn't necessary, but it'
existing issue anyway.
-### Contributing using GitHub
+### Pull Request at GitHub
This is our preferred way for contributing code. Our root GitHub repository is located at
[https://github.com/apache/brooklyn](https://github.com/apache/brooklyn) with most of the code in one of the subprojects.
@@ -65,11 +64,10 @@ Your commit messages must properly describes the changes that have been made and
([here are some guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)). If your
contributions fix a Jira issue, then ensure that you reference the issue (like `BROOKLYN-9876`) in the commit message.
-Create a pull request (PR) in GitHub for the change you're interested in making. The comment section of the PR must
-contain a link to the Jira issue (if it has one).
+Create a pull request (PR) in GitHub for the change you're interested in making.
+Include a link to the Jira issue (if it has one) in the PR comment as well as the commit message.
-Some good references for working with GitHub are below. We ask that you keep your change rebased to master as much
-as possible, and we will ask you to rebase again if master has moved before accepting your patch.
+Some good references for working with GitHub are below.
- [Setting Up Git with GitHub](https://help.github.com/articles/set-up-git)
- [Forking a Repository](https://help.github.com/articles/fork-a-repo)
@@ -78,21 +76,24 @@ as possible, and we will ask you to rebase again if master has moved before acce
Finally, add a comment in the Jira issue with a link to the pull request so we know the code is ready to be reviewed.
-### Reviews
+### The Review Process
-The Apache Brooklyn community will review your pull request before it is merged. This process can take a while, so
-please be patient. If we are slow to respond, please feel free to post a reminder to the PR, Jira issue, IRC channel
-or mailing list - see the [Community](../community/) page to see how to contact us.
+The Apache Brooklyn community will review your pull request before it is merged.
+If we are slow to respond, please feel free to post a reminder to the PR, Jira issue, IRC channel
+or mailing list -- see the [Community](../community/) page to see how to contact us.
During the review process you may be asked to make some changes to your submission. While working through feedback,
it can be beneficial to create new commits so the incremental change is obvious. This can also lead to a complex set
of commits, and having an atomic change per commit is preferred in the end. Use your best judgement and work with
your reviewer as to when you should revise a commit or create a new one.
-A pull request is considered ready to be merged once it gets at lease one +1 from a committer. Once all the changes
-have been completed and the pull request is accepted, you may be asked to rebase it against the latest code. You may
-also wish to squash some commits together and make other history revisions, to leave the commit history clean and
-easily understood.
+You may also get automated messages on the pull request from the CI running tests
+or GitHub determining whether a PR can be merged.
+Please keep these up to date to aid reviewers.
+
+A pull request is considered ready to be merged once it gets at lease one +1 from a committer.
+At this point your code will be included in the latest Apache Brooklyn.
+Congratulations and thank you!
### Contributing without using GitHub
@@ -107,8 +108,10 @@ $ git clone https://git-wip-us.apache.org/repos/asf/brooklyn-server.git
When producing patches, please use `git format-patch` or a similar mechanism - this will ensure that you are properly
attributed as the author of the patch when a committer merges it.
+The review process will be as with pull requests, except for comments only appearing on the Jira issue.
-## Handy Places
+### Handy Places
-Development bookmarks are available [here](links.html).
+If you've not done so, you'll probably want to start by [getting the code](code/).
+Once you've done that, you'll find [handy development bookmarks here](links.html).
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/92721a76/website/developers/links.md
----------------------------------------------------------------------
diff --git a/website/developers/links.md b/website/developers/links.md
index 324a633..b5da4ee 100644
--- a/website/developers/links.md
+++ b/website/developers/links.md
@@ -5,15 +5,14 @@ title: Handy Places
{% include fields.md %}
-Handy places:
-
* **Code** is in Github at [https://github.com/apache/brooklyn/](https://github.com/apache/brooklyn/)
* **Issues** are in Jira at [https://issues.apache.org/jira/browse/BROOKLYN/](https://issues.apache.org/jira/browse/BROOKLYN/)
-* **Maven repositories** are:
+* **Maven repositories** are at:
+
* [Apache releases]({{ apache_releases_repo_groupid_url }})
* [Apache snapshots]({{ apache_snapshots_repo_groupid_url }})
-
-* **CI server** is a jenkins server at: [https://builds.apache.org/job/brooklyn-master-build/](https://builds.apache.org/job/brooklyn-master-build/)
+
+* **CI** is done by Jenkins at [https://builds.apache.org/job/brooklyn-master-build/](https://builds.apache.org/job/brooklyn-master-build/)