How to contribute

(Taking PatternFly-Angular as an example)
If you're reading this, you're awesome! Thank you for helping us make this project great and being a part of the PatternFly community. Here are a few guidelines that will help you along the way.

Asking Questions

For how-to questions and other non-issues, please use the following ways instead of Github issues.

• IRC - freenode #patternfly-angular
• Slack - patternfly.slack.com #general
• Mailing List - Subscribe to our mailing list to participate or follow a variety of discussions on both technical and design topics. Older threads are found in the archive

Opening an Issue

If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been reported or fixed. You can search through existing issues and PRs to see if someone has reported one similar to yours.

Next, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and steps to reproduce it.

For code issue please include:

• Device Type
• Browser Version
• JS framework Version
• A code example or link to a repo, or running site or a screenshot of the code.

Issue Guidelines

Please begin the title with '[ComponentName]' where appropriate, and use a succinct description. "doesn't work" doesn't help others find similar issues.

Please don't group multiple topics into one issue, but instead each should be its own issue.

And please don't just '+1' an issue. It spams the maintainers and doesn't help move the issue forward.

Submitting a Pull Request

PatternFly is a community project, so pull requests are always welcome, but before working on a large change, it is best to open an issue first to discuss it with the maintainers.

When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.

How to make a pull request

Please create a new branch from an up to date master on your fork.

1. Fork the PatternFly-Angular repository on Github
2. Clone your fork to you local machine: git clone git@github.com:<yourname>/patternfly-angular.git
3. Create a branch: git checkout -b my-topic-branch
4. Make your changes, commit, then push to github with: git push origin my-topic-branch
5. Visit github and make your pull request.

Coding style

Please follow the coding style of the current code base. See http://codeguide.patternfly.org

Roadmap

To get a sense of where PatternFly is heading, or for ideas on where you could contribute, take a look at the roadmap.