fh-fhc/CONTRIBUTING.md

A Command Line Interface for FeedHenry

# How to contribute

Thank you for your interest in contributing to the FeedHenry project. We want
keep this process as easy as possible so we've outlined a few guidelines below. 
For more information about the FeedHenry project, visit 
[our website](http://feedhenry.org/).

## Asking for help

Whether you're contributing a new feature or bug fix, or simply submitting a
ticket, the FeedHenry team is available for technical advice or feedback. 
You can reach us at #feedhenry on [Freenode IRC](https://freenode.net/) or the 
[feedhenry-dev list](https://www.redhat.com/mailman/listinfo/feedhenry-dev) 
-- both are actively monitored.

## Getting started

* Make sure you have a [JIRA account](https://issues.jboss.org)
* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit a ticket for your issue to the 
[FeedHenry project](https://issues.jboss.org/projects/FH/), assuming one does 
not already exist.
  * Clearly describe the issue including steps to reproduce when it is a bug.
  * Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub.

## Making changes

* Create a topic branch from where you want to base your work.
  * This is usually the master branch.
  * To quickly create a topic branch based on master; `git checkout -b
    <branch name> master`. By convention we typically include the JIRA issue 
    key in the branch name, e.g. `FH-1234-my-feature`.
  * Please avoid working directly on the `master` branch.
* Make commits of logical units.
* Prepend your commit messages with a JIRA ticket number, e.g. "FH-1234: Fix
  spelling mistake in README."
* Follow the coding style in use.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure you have added the necessary tests for your changes.
* Run _all_ the tests using the `$grunt test` command to make sure your change did not accidentally introduce a bug.

## Submitting changes

* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository in the [FeedHenry GitHub organization]
  (https://github.com/feedhenry) and choose branch you want to patch 
  (usually master). 
  * Advanced users may want to install the [GitHub CLI](https://hub.github.com/) 
    and use the `hub pull-request` command.
* Update your JIRA ticket to mark that you have submitted code and are ready 
for it to be reviewed (Status: PULL REQUEST SENT).
  * Include a link to the pull request in the ticket. ( `Git Pull Request` )
* Add detail about the change to the pull request including screenshots 
  if the change affects the UI.

## Reviewing changes

* After submitting a pull request, one of FeedHenry team members will review it.
* Changes may be requested to conform to our style guide and internal 
  requirements.
* When the changes are approved and all tests are passing, a FeedHenry team
  member will merge them.
* Note: if you have write access to the repository, do not directly merge pull 
  requests. Let another team member review your pull request and approve it.

## Before Merge
* Bump the version in the files; `npm-shrinkwrap.json`, `package.json`, `sonar-project.properties`, e.g. version": "3.2.0-BUILD-NUMBER"
* CHANGELOG.md should be updated with all notable changes
* Ensure that the commits in the PR are properly squashed and commit messages meet the format below. 
* Ensure that the code doesn't have sonar issues/comments ( E.g MENOR )

### __*Commit Message Format:*__

All commit messages should adhere to the following standard:

```
<type>[optional scope]: <description> [issue reference**]
 
[optional body]
 
[optional footer]
```

** if commit relates to a specific JIRA/ issue ticket include the reference here.

Examples of commits following this convention:

- bug-fixes: `git commit -a -m "fix(parsing): fixed a bug in our parser (RHMAP-1234)"`
- features: `git commit -a -m "feat(parser): we now have a parser \o/ (FH-3456)"`
- breaking changes: 
```
git commit -a -m "feat(new-parser): introduces a new parsing library (FH-6789)
BREAKING CHANGE: new library does not support foo-construct"
```
- other changes: `git commit -a -m "docs: fixed up the docs a bit"`

## Coding best practices

We have compiled a set of best practices for each programming
language we use. View them [here](https://github.com/fheng/best_practice).

# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details