| 1 | # Contributing to ag-grid-react
|
| 2 |
|
| 3 | We would love for you to contribute to ag-grid-react and help make it even better than it is
|
| 4 | today! As a contributor, here are the guidelines we would like you to follow:
|
| 5 |
|
| 6 | - [Question or Problem?](#question)
|
| 7 | - [Issues and Bugs](#issue)
|
| 8 | - [Feature Requests](#feature)
|
| 9 | - [Submission Guidelines](#submit)
|
| 10 | - [Coding Rules](#rules)
|
| 11 | - [Commit Message Guidelines](#commit)
|
| 12 | - [Signing the CLA](#cla)
|
| 13 |
|
| 14 | ## <a name="question"></a> Got a Question or Problem?
|
| 15 |
|
| 16 | Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/ag-grid) where the questions should be tagged with tag `ag-grig`,
|
| 17 | or on our [Forum](https://ag-grid.com/forum)
|
| 18 |
|
| 19 | If you're using the Enterprise version of AG Grid (ag-grid-enterprise), then the [Members Forum](https://ag-grid.com/forum/forumdisplay.php?fid=5) is the best place to ask - you'll get a much quicker response there. Please contact accounts@ag-grid.com for access.
|
| 20 |
|
| 21 | To save your and our time we will be systematically closing all the issues that are requests for general support (for AG Grid Community) and redirecting people to StackOverflow.
|
| 22 |
|
| 23 | ## <a name="issue"></a> Found a Bug?
|
| 24 | If you find a bug in the source code, you can help us by
|
| 25 | [submitting an issue](#submit-issue) to our [GitHub Repository][github].
|
| 26 |
|
| 27 | ## <a name="feature"></a> Missing a Feature?
|
| 28 | You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
|
| 29 | Repository.
|
| 30 |
|
| 31 | ## <a name="submit"></a> Submission Guidelines
|
| 32 |
|
| 33 | ### <a name="submit-issue"></a> Submitting an Issue
|
| 34 |
|
| 35 | Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
|
| 36 |
|
| 37 | We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using http://plnkr.co. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
|
| 38 |
|
| 39 | - version of React used
|
| 40 | - 3rd-party libraries and their versions
|
| 41 | - and most importantly - a use-case that fails
|
| 42 |
|
| 43 | A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If plunker is not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem.
|
| 44 |
|
| 45 | We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
|
| 46 |
|
| 47 | You can file new issues by filling out our [new issue form](https://github.com/ag-grid/ag-grid-react/issues/new).
|
| 48 |
|
| 49 | [github]: https://github.com/ag-grid/ag-grid-react
|
| 50 | [jsfiddle]: http://jsfiddle.net
|
| 51 | [plunker]: http://plnkr.co/edit
|
| 52 | [runnable]: http://runnable.com
|
| 53 | [stackoverflow]: http://stackoverflow.com/questions/tagged/ag-grid
|