You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by st...@apache.org on 2012/07/03 18:09:10 UTC
svn commit: r1356808 [3/3] - in /incubator/deltaspike/site/trunk:
content/deltaspike/ content/deltaspike/resources/ templates/
Added: incubator/deltaspike/site/trunk/content/deltaspike/suggested-git-workflows.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/suggested-git-workflows.mdtext?rev=1356808&view=auto
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/suggested-git-workflows.mdtext (added)
+++ incubator/deltaspike/site/trunk/content/deltaspike/suggested-git-workflows.mdtext Tue Jul 3 16:09:07 2012
@@ -0,0 +1,163 @@
+Title:
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Suggested workflows
+
+Feel free to add suggestions for workflows which lead to a clean history on the central clone. The description should be useful also for beginners to allow an easier start for new committers.
+
+## Avoid git-pull!
+
+git-pull should never get invoked if you have dirty files lying around or if your branch is ahead of master.
+This will always lead to some dirty artifacts in the commit history:
+
+ Merge branch 'master' of http://git-wip-us.apache.org/deltaspike into master
+
+## git pull --rebase
+
+An easy version for getting rid of the auto-merges is using
+
+ %> git pull --rebase
+
+Please not that this sometimes trashes your working tree if there are unmergeable files around. Cleaning this up with a forced manual rebase is not something I'd recommend for a git beginner.
+
+### working in an own branch
+
+This is actually the suggested way to prevent auto-merges.
+
+Create an own branch where you do your feature work. Either do all your work in one branch or create one branch per feature you are working on.
+
+ %> git branch mybranch
+
+After you finished your feature, git-add and git-commit your work. Check with git-status that you don't have any dirty files and uncommitted changes around. You can use git-stash to 'backup' unfinished work.
+
+Then switch back to the master branch and pull changes done by other committers in the meantime.
+
+ %> git checkout master
+ %> git pull --rebase
+
+You should now get all the changes done by other committers and the will get applied to your local master branch.
+Now go back to your private branch and rebase your locally performed work to the HEAD of master.
+
+ %> git checkout mybranch
+ %> git rebase master
+
+If you got conflicts, you will get lines with ">>>>" added to those files. Resolve those conflicts manually, add them and finish the rebase.
+
+Check with git-status and gitk if the merge went well and the history now contains your changes.
+If all is well, go back to the master branch and merge your changes in.
+
+ %> git pull --rebase // (just for safety, you should see no changes)
+ %> git checkout master
+ %> git merge mybranch
+
+Finally you can push your changes to the ASF git repo
+
+ %> git push
+
+
+## Contribution workflow
+
+### Creating patches
+
+You should use the following workflow if you plan to contribute patches or new features to DeltaSpike.
+
+First update you local copy of the repository:
+
+{code}
+ %> git checkout master
+ %> git pull --rebase
+{code}
+
+Then create a new local branch for your work. It's good practice to name it after the corresponding JIRA issue.
+
+{code}
+ %> git checkout -b DELTASPIKE-XXX
+{code}
+
+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.
+
+{code}
+ %> git add -am "DELTASPIKE-XXX: Fixed some issue"
+{code}
+
+For small patches we recommend to do a single commit containing your changes. For larger contributions you should try to group your work into separate sub-tasks that you can commit one by one.
+
+Before you create your patch you should make sure that your local repository is up to date with the master repository. This is very important especially if you work on your branch for a long time. Use the following commands to pull the latest changes from the upstream repository and rebase your branch against the current master.
+
+{code}
+ %> git checkout master
+ %> git pull --rebase
+ %> git checkout DELTASPIKE-XXX
+ %> git rebase master
+{code}
+
+Now you are ready to create your patch:
+
+{code}
+ %> git checkout DELTASPIKE-XXX
+ %> git format-patch --stdout master > ../DELTASPIKE-XXX.patch
+{code}
+
+Please attach the resulting patch file to the correspoding JIRA issue.
+
+### Applying patches
+
+If you are a committer and want to apply a patch you should do so in a separate branch.
+
+{code}
+ %> git checkout -b DELTASPIKE-XXX
+{code}
+
+Then apply the patch using "git-am" and rebase it against the master branch.
+
+{code}
+ %> git am < ../DELTASPIKE-XXX.patch
+ %> git rebase master
+{code}
+
+After reviewing the changes and testing the code, the changes are ready to be merged into the master branch:
+
+{code}
+ %> git checkout master
+ %> git merge DELTASPIKE-XXX
+ %> git branch -d DELTASPIKE-XXX
+{code}
+
+## Discussion workflow (optional)
+
+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 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 with GitHub - for sure it works with any hosting platform like BitBucket, Google-Code,... The only important part here is that such branches *NEVER* get pushed to the main Apache repository to keep the commit history as clean as possible.
+
+{code:title=Initial setup}
+ %> git clone https://git-wip-us.apache.org/repos/asf/incubator-deltaspike.git ./
+ %> git remote add discuss https://[username]@github.com/[username]/[repo-name].git
+ %> git push -u discuss master
+{code}
+
+{code:title=Branches for discussions}
+ %> git checkout -b DELTASPIKE-XXX
+ //1-n commits
+ %> git push discuss DELTASPIKE-XXX
+ //share the link to the branch for the discussions
+{code}
+
+*If the community agrees on the suggested change, the implementation will be applied to the origin master. A committer has to follow the steps described above for the basic workflow to keep the commit history simple, clean and straight. A contributor has to follow the steps described above for creating a patch.*
+
+{code:title=Delete the branch again}
+ %>git push discuss :DELTASPIKE-XXX
+ %>git branch -d DELTASPIKE-XXX
+{code}
\ No newline at end of file
Propchange: incubator/deltaspike/site/trunk/content/deltaspike/suggested-git-workflows.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext?rev=1356808&view=auto
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext (added)
+++ incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext Tue Jul 3 16:09:07 2012
@@ -0,0 +1,55 @@
+Title: DeltaSpike supporters
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+Apache DeltaSpike gets support from many community members.
+
+# Git Mirrors
+
+Besides the official GitHub mirror there are the following mirrors:
+ * https://github.com/DeltaSpike/Mirror (+ the corresponding internal [Irian|http://www.irian.at] mirror for the sync.)
+
+# Mailing-list Mirrors
+
+ * [Markmail|http://incubator.markmail.org/search/?q=list%3Aorg.apache.incubator.deltaspike-dev]
+ * [Nabble|https://s.apache.org/deltaspike-dev_nabble]
+
+# (Integration) Tests
+So far we test the following environments on a regular basis (daily ci build)
+
+ * Apache OpenWebBeans (embedded)
+ ** Apache build server
+ * JBoss Weld (embedded)
+ ** Apache build server
+ * JBoss AS7
+ ** [c4j|http://www.c4j.be]
+ * Glassfish 3.1.x
+ ** [c4j|http://www.c4j.be]
+ * Apache TomEE
+ ** Apache build server
+
+So far we test the following environments on a regular basis (manually)
+ * Weblogic Server 12c
+ ** [c4j|http://www.c4j.be]
+
+As soon as we have the corresponding config (and/or Arquillian Plugin)
+ * Apache Tomcat 7
+ ** DeltaSpike committers (manually)
+ * Jetty
+ ** DeltaSpike committers (manually)
+
+*Feel free to support us* as well with new environments or with one of the environments we already check on a regular basis (to unburden/backup our existing supports).
Propchange: incubator/deltaspike/site/trunk/content/deltaspike/supporters.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext?rev=1356808&view=auto
==============================================================================
--- incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext (added)
+++ incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext Tue Jul 3 16:09:07 2012
@@ -0,0 +1,29 @@
+Title: Tool Configuration
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+This page contains settings for various tools used at developing Apache DeltaSpike.
+
+# IDE
+
+## IntelliJ
+
+[Attached|^settings.jar] you can find the settings for formatting the source code. Import them via File | Import Settings...
+
+## Eclipse
+
+For Eclipse you can use this [Code Formatter Profile|^deltaspike-code-conventions.xml]. Import it via Window | Preferences | Java | Code Style | Formatter
Propchange: incubator/deltaspike/site/trunk/content/deltaspike/tools.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/deltaspike/site/trunk/templates/standard.html
URL: http://svn.apache.org/viewvc/incubator/deltaspike/site/trunk/templates/standard.html?rev=1356808&r1=1356807&r2=1356808&view=diff
==============================================================================
--- incubator/deltaspike/site/trunk/templates/standard.html (original)
+++ incubator/deltaspike/site/trunk/templates/standard.html Tue Jul 3 16:09:07 2012
@@ -34,12 +34,12 @@ under the License.
</head>
<body>
<div id="page" class="container_16">
- <div id="header" class="grid_7 alpha">
+ <div id="header" class="grid_8 alpha">
<img src="http://www.apache.org/images/feather-small.gif" alt="The Apache Software Foundation">
<span id="projectname">Apache DeltaSpike</span>
</div>
- <div id="nav" class="grid_9 omega">
+ <div id="nav" class="grid_8 omega">
<ul>
<!-- <li><a href="/" title="Welcome!">Home</a></li> -->
<li><a href="http://www.apache.org/foundation/" title="The Foundation">Foundation</a></li>