deltaspike-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From johndam...@apache.org
Subject deltaspike git commit: DELTASPIKE-1188 Added some PR based contribution workflow. Replaced the mail archive link with pony.
Date Sun, 14 Aug 2016 23:08:19 GMT
Repository: deltaspike
Updated Branches:
  refs/heads/master a1827f70c -> 4c924c422


DELTASPIKE-1188 Added some PR based contribution workflow.  Replaced the mail archive link
with pony.


Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/4c924c42
Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/4c924c42
Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/4c924c42

Branch: refs/heads/master
Commit: 4c924c422352a96804ec382aeed29b79dc74c642
Parents: a1827f7
Author: John D. Ament <johndament@apache.org>
Authored: Sat Jul 23 11:58:18 2016 -0400
Committer: John D. Ament <johndament@apache.org>
Committed: Sun Aug 14 19:06:05 2016 -0400

----------------------------------------------------------------------
 site/src/main/asciidoc/community.adoc           | 12 ++--
 site/src/main/asciidoc/download.adoc            |  2 +-
 .../main/asciidoc/suggested-git-workflows.adoc  | 70 ++++++++++++++++++--
 3 files changed, 72 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/4c924c42/site/src/main/asciidoc/community.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/community.adoc b/site/src/main/asciidoc/community.adoc
index 7876592..5f4685c 100644
--- a/site/src/main/asciidoc/community.adoc
+++ b/site/src/main/asciidoc/community.adoc
@@ -44,8 +44,8 @@ publish it.
 Before you get a committer you have to contribute to our effort. E.g.
 you can help users, participate in discussions on the dev list, submit
 patches,... . Therefore, it's essential to file a/n
-http://www.apache.org/licenses/icla.txt[(I)CLA] or
-http://www.apache.org/licenses/cla-corporate.txt[CLA] and send it to
+http://www.apache.org/licenses/icla.pdf[ICLA] or
+http://www.apache.org/licenses/cla-corporate.txt[CCLA] and send it to
 secretary at apache dot org (or fax it) as early as possible.
 
 If you would like to submit a patch through Jira, you can have a look at
@@ -88,21 +88,21 @@ Further details are available at http://www.apache.org/dev/.
 |mailto:users@deltaspike.apache.org[User List]
 |mailto:users-subscribe@deltaspike.apache.org[Subscribe]
 |mailto:users-unsubscribe@deltaspike.apache.org[Unsubscribe]
-|http://mail-archives.apache.org/mod_mbox/deltaspike-users/[Archive]
+|link:++https://lists.apache.org/list.html?users@deltaspike.apache.org++[Archive]
 |
 |
 
 |mailto:dev@deltaspike.apache.org[Developer List]
 |mailto:dev-subscribe@deltaspike.apache.org[Subscribe]
 |mailto:dev-unsubscribe@deltaspike.apache.org[Unsubscribe]
-|http://mail-archives.apache.org/mod_mbox/deltaspike-dev/[Archive]
+|link:++https://lists.apache.org/list.html?dev@deltaspike.apache.org++[Archive]
 |
 |
 
 |mailto:commits@deltaspike.apache.org[Committer List]
 |mailto:commits-subscribe@deltaspike.apache.org[Subscribe]
 |mailto:commits-unsubscribe@deltaspike.apache.org[Unsubscribe]
-|http://mail-archives.apache.org/mod_mbox/deltaspike-commits/[Archive]
+|link:++https://lists.apache.org/list.html?commits@deltaspike.apache.org++[Archive]
 |
 |
 |
@@ -140,4 +140,4 @@ $ irssi
 -------------------------------------
 
 If you are new to IRC you can use the pre-configures web-client you can
-find http://people.apache.org/~gpetracek/deltaspike/freenode.html[here].
+find https://kiwiirc.com/client/irc.freenode.net/#deltaspike[here].

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/4c924c42/site/src/main/asciidoc/download.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/download.adoc b/site/src/main/asciidoc/download.adoc
index fce2bf1..3de4ffc 100644
--- a/site/src/main/asciidoc/download.adoc
+++ b/site/src/main/asciidoc/download.adoc
@@ -36,7 +36,7 @@ v{latestStable}
 == Maven Dependencies
 
 
-Details are available http://deltaspike.apache.org/documentation/configure.html#Maven-basedProjects[here].
+Details are available /documentation/configure.html#MavenProjects[here].
 
 
 == Previous Releases

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/4c924c42/site/src/main/asciidoc/suggested-git-workflows.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/suggested-git-workflows.adoc b/site/src/main/asciidoc/suggested-git-workflows.adoc
index c9a0d47..a4e441d 100644
--- a/site/src/main/asciidoc/suggested-git-workflows.adoc
+++ b/site/src/main/asciidoc/suggested-git-workflows.adoc
@@ -82,12 +82,72 @@ Finally you can push your changes to the ASF git repo
 $ git push
 -----------
 
-
 == Contribution workflow
 
+Please understand that our contribution workflow is designed for outside contributions. 
They should represent your
+changes and your changes alone.  Any other contributors should raise their own pull request
or submit their own patch.
+Committers should continue to follow the discussion flow for complex changes, and merge their
changes when ready.
 
-=== Creating patches
+=== Raising Pull Requests
+
+You should use the following workflow if you plan to contribute features or bug fixes to
Apache DeltaSpike via GitHub
+
+First, fork our repository https://github.com/apache/deltaspike[on github]
+
+Second, clone it locally and add our upstream as a remote
+
+----------------------
+$ git clone https://github.com/<YOUR USERNAME>/deltaspike
+$ git remote add asf https://git-wip-us.apache.org/repos/asf/deltaspike.git
+----------------------
+
+Third, find a JIRA ticket to work on.  When you do, use that as your branch name
+
+---------------------------------
+$ git checkout -b DELTASPIKE-XXX
+---------------------------------
+
+Now you can start to work on your patch. When you are finished, commit
+your changes. But don't forget to **add the name of the JIRA issue to
+the commit message**.
+
+-------------------------------------------------
+$ git commit -am "DELTASPIKE-XXX: Fixed some issue"
+-------------------------------------------------
+
+Once you're done with your changes, make sure you're up to date and rebase from master
 
+-------------------------------------------------
+$ git pull asf master --rebase
+-------------------------------------------------
+
+Next, push your branch to GitHub
+
+-------------------------------------------------
+$ git push origin DELTASPIKE-XXX
+-------------------------------------------------
+
+Finally, raise your PR.  If you go to your GitHub fork of DeltaSpike, you should see an option
to create a PR
+
+=== Merging Pull Requests
+
+Whenever a PR gets created for DeltaSpike, an email is sent to the dev@deltaspike.  It will
include the subject
+
+-------------------------------------------------
+[GitHub] deltaspike pull request #00: DELTASPIKE-XXX some changes
+-------------------------------------------------
+
+Which will contain the instructions
+
+-------------------------------------------------
+You can merge this pull request into a Git repository by running:
+
+$ git pull https://github.com/<GITHUB USERNAME>/deltaspike DELTASPIKE-XXX
+-------------------------------------------------
+
+As long as you don't rebase, pushing the result of this pull will merge the change into our
git repository and close the PR.  If there are any issues with the patch, you can monitor
the build status from the PR, where we run some smoke tests against the commit to ensure its
working.  Please make the requestor aware of any issues identified (e.g. code quality, formatting,
missing tests, etc).
+
+=== Creating patches
 
 You should use the following workflow, if you plan to contribute patches or new features
to DeltaSpike.
 
@@ -109,7 +169,7 @@ your changes. But don't forget to **add the name of the JIRA issue to
 the commit message**.
 
 -------------------------------------------------
-$ git add -am "DELTASPIKE-XXX: Fixed some issue"
+$ git commit -am "DELTASPIKE-XXX: Fixed some issue"
 -------------------------------------------------
 
 For small patches we recommend to do a single commit containing your
@@ -172,8 +232,8 @@ $ git branch -d DELTASPIKE-XXX
 
 
 All discussions which lead to a decision take place on the mailing list.
-Sometimes it's required to show-case an idea esp. if the solution is
-more than few lines. As shown above it makes sense to use local branches
+Sometimes it's required to show-case an idea especially if the solution is
+more than a few lines. As shown above it makes sense to use local branches
 for developing new parts. Git allows to push such local branches to a
 public repository. So it's easier to share it with the community for
 discussing it. The following listings show an example in combination


Mime
View raw message