Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Adjustment on CONTRIBUTING

  • Loading branch information...
commit 79886728fd3a085be839cf598f422f019cfbcccd 1 parent 1de9bef
@rafabene rafabene authored
Showing with 25 additions and 12 deletions.
  1. +25 −12 CONTRIBUTING.md
View
37 CONTRIBUTING.md
@@ -6,29 +6,42 @@ BOMs are Maven pom.xml files that specify the versions of all runtime dependenci
Basic Steps
-----------
-To contribute BOMs, fork the main BOM repository, clone your fork, commit your work on topic branches, and make pull requests.
+To contribute to the JBoss BOMs, fork the JBoss BOMs repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.
-Here are the steps:
+If you don't have the Git client (`git`), get it from: <http://git-scm.com/>
-1. [Fork](https://github.com/jboss-jdf/jboss-bom/fork_select) the project.
+Here are the steps in detail:
-2. Clone your fork (`git@github.com:<your-username>/jboss-bom.git`).
+1. [Fork](https://github.com/jboss-jdf/jboss-bom/fork_select) the project. This creates a the project in your own Git.
-3. Add an `upstream` remote (`git remote add upstream git@github.com:jboss-jdf/jboss-bom.git`).
+2. Clone your fork. This creates a directory in your local file system.
-4. Get the latest changes from upstream (e.g. `git pull upstream master`).
+ git clone git@github.com:<your-username>/jboss-bom.git
-5. Create a new topic branch to contain your feature, change, or fix (`git checkout -b <topic-branch-name>`).
+3. Add the remote `upstream` repository.
-6. Make sure that your changes follow the General Guidelines below.
+ git remote add upstream git@github.com:jboss-jdf/jboss-bom.git
-7. Commit your changes to your topic branch.
+4. Get the latest files from the `upstream` repository.
-8. Push your topic branch up to your fork (`git push origin <topic-branch-name>`).
+ git fetch upstream
-9. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a clear title and description.
+5. Create a new topic branch to contain your features, changes, or fixes.
-If you don't have the Git client (`git`), get it from: <http://git-scm.com/>
+ git checkout -b <topic-branch-name> upstream/master
+
+6. Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.
+
+7. Commit your changes to your local topic branch. You must use `git add filename` for every file you create or change.
+
+ git add <changed-filename>
+ git commit -m `Description of change...`
+
+8. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.
+
+ git push origin HEAD
+
+9. Browse to the <topic-branch-name> branch on your forked Git repository and [open a Pull Request](http://help.github.com/send-pull-requests/). Give it a clear title and description.
General Guidelines
------------------
Please sign in to comment.
Something went wrong with that request. Please try again.