UNPKG

4.51 kBMarkdownView Raw
1# Contributing to ag-Grid-Enterprise
2
3ag-Grid-Enterprise is copyright commercial software. If you provide a PR, you must also state that you agree to the following:
4
5Retention of Intellectual Property Rights for ag-Grid-Enterprise component
6==============
7
8
91.DEFINITIONS
10
11“the Software” means the ag-Grid-Enterprise software as location the the repository
12https://github.com/ag-grid/ag-grid-enterprise.
13
14“Software Rights” means all intellectual property rights inherent in or relating to the Software,
15which include, but are not limited to, all copyright, patent rights, all rights in relation to registered
16and unregistered trademarks (including service marks) and confidential information (including trade secrets
17and know-how)
18
192.RETENTION OF INTELLECTUAL PROPERTY RIGHTS
20
21AG GRID LTD reserve ownership of all software rights for the software. Upon contributing to the software
22you agree to grant AG GRID LTD all software rights free of charge. You acknowledge that all software rights
23will belong to AG GRID LTD and will not seek payment. AG GRID LTD reserve the right to do with the software
24what it wishes. AG GRID LTD is under no obligation as to what it does with the contributed software.
25
26 - [Question or Problem?](#question)
27 - [Issues and Bugs](#issue)
28 - [Feature Requests](#feature)
29 - [Submission Guidelines](#submit)
30 - [Coding Rules](#rules)
31 - [Commit Message Guidelines](#commit)
32 - [Signing the CLA](#cla)
33
34## <a name="question"></a> Got a Question or Problem?
35
36Please, 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`,
37or on our [Forum](https://ag-grid.com/forum)
38
39If 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.
40
41To save your and our time we will be systematically closing all the issues that are requests for general support (for ag-Grid Free) and redirecting people to StackOverflow.
42
43## <a name="issue"></a> Found a Bug?
44If you find a bug in the source code, you can help us by
45[submitting an issue](#submit-issue) to our [GitHub Repository][github].
46
47## <a name="feature"></a> Missing a Feature?
48You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
49Repository.
50
51## <a name="submit"></a> Submission Guidelines
52
53### <a name="submit-issue"></a> Submitting an Issue
54
55Before 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.
56
57We 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:
58
59- version of ag-Grid-Enterprise used
60- 3rd-party libraries and their versions
61- and most importantly - a use-case that fails
62
63A 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.
64
65We 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.
66
67You can file new issues by filling out our [new issue form](https://github.com/ag-grid/ag-grid-enterprise/issues/new).
68
69[github]: https://github.com/ag-grid/ag-grid-enterprise
70[jsfiddle]: http://jsfiddle.net
71[plunker]: http://plnkr.co/edit
72[runnable]: http://runnable.com
73[stackoverflow]: http://stackoverflow.com/questions/tagged/ag-grid
74
75