098_contributing_to_ui-grid.ngdoc

@ngdoc overview
@name Tutorial: 098 Contributing to ui-grid
@description

## Contributing ##

The ui-grid team is reasonably small, and this is a large project.  We are always looking for
contributors to assist to make this the default grid for all angularJS projects.

There are a number of ways you can contribute, all of which add value to the team:

1. Raising high quality issues in the issue tracker, and helping to diagnose and resolve them
2. Assisting with documentation updates and helping others who have issues in the issue tracker
3. Providing patches for point issues through submission of pull requests
4. Contributing features or core development to the project

We are a friendly project that welcomes new members, and we have tried to provide guides that
allow both open source pros and first timers to open source to contribute to the project.

## Issues in the issue tracker ##
Refer to [CONTRIBUTING.md](https://github.com/angular-ui/ui-grid/blob/master/CONTRIBUTING.md),
in the issue tracker and bug report sections.

In short, the issue tracker should be used for _demonstrable problems_ in the code.  You should
tell us what version you're using, what the problem is that you have, what you expected to happen
instead, and if possible provide a plunkr that demonstrates the problem.

The easiest way to get a plunkr is to start with one of the tutorials, click the "edit" button,
and then adjust it in the plunkr to match the configuration in your code.  Then click the save
button, and copy and paste the url into your issue.

There is a lot more detail in [CONTRIBUTING.md](https://github.com/angular-ui/ui-grid/blob/master/CONTRIBUTING.md),
read it and follow it.


## Documentation updates and helping with other people's issues ##

As you get more familiar with ui-grid, you'll find that some things in the documentation aren't
described as well as you think they could be, or you'll start to build knowledge that is enough
to answer questions.

Register for gitter, and get a github account.  Answer questions where you have the knowledge to
do so, freeing up the core team to work on the more complex issues.  Remember that you don't have to
always be right, this is an open source project run by volunteers.  So long as you have good intentions
and your courteous, then your contributions will be valued.  The only way to increase your knowledge is
to start, and we all started in the same place.

If you want to contribute documentation updates, these are the easiest area of pull requests to submit.
Take a look at the [first timers guide](https://github.com/angular-ui/ui-grid/blob/master/FIRST_TIMER.md),
and do your first pull request.  It's not as hard as it looks from the outside!!


## Providing patches, contributing features, core development ##

If you're already a pro with open source, github and the development tools, dive straight in.  Look
at [CONTRIBUTING.md](https://github.com/angular-ui/ui-grid/blob/master/CONTRIBUTING.md) and
[DEVELOPER.md](https://github.com/angular-ui/ui-grid/blob/master/DEVELOPER.md), and get working!!

Key things to watch out for are:

1. We don't have unit tests everywhere as yet, but we want to.  Pull requests should have run the
unit tests before submission, and all unit tests should be working.  Ask for help if you can't fix
them.
2. All new PRs should come with unit tests
3. Similarly, we don't yet have ngdoc everywhere, but we have it in most places.  All new pull requests
should come with ngdocs, and where appropriate, a new or extended tutorial
4. End-to-end tests are least complete, but at a minimum the existing end-to-end tests must continue to
run, so run them before submitting
5. Squash all your commits - each pull request should have only a single commit.  It's much easier to
do this before you push to github - once you've pushed to github then squashing your commits generally
requires you to create a new branch.
6. Follow the coding style, including 2 spaces for indent

If you're more of a first timer with open source, then look at [First time guide](https://github.com/angular-ui/ui-grid/blob/master/FIRST_TIMER.md).
Some of it you'll already know, other bits may be new.  Our aim with this guide is to collate as much as possible of the
questions and answers that we've covered through gitter and other channels, and make that information
accessible to new contributors.