CONTRIBUTING.md

Contributing Guide

If you are going to propose a new feature or a change to the current design you should open an issue before spending time on it.

Adhering to the following process is the best way to get your work included in the project:

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/jenkins-reloaded-theme.git
   # Navigate to the newly cloned directory
   cd jenkins-reloaded-theme
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/artberri/jenkins-reloaded-theme.git

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

4. Make your changes. You can check in the README.md file how to setup a development environment.

5. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

6. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream master

7. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

8. Open a Pull Request with a clear title and description against the master branch.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.