Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (23 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

44 lines (23 loc) · 1.63 KB

plugin-jdf Contributing Guide

Basic Steps

To contribute to the plugin-jdf, fork the plugin-jdf repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

     git clone git@github.com:<your-username>/plugin-jdf.git

  3. Add the remote upstream repository.

     git remote add upstream git@github.com:jboss-jdf/plugin-jdf.git

  4. Get the latest files from the upstream repository.

     git fetch upstream

  5. Create a new topic branch to contain your features, changes, or fixes.

     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 branch on your forked Git repository and open a Pull Request. Give it a clear title and description.