|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Please read these guidelines before contributing to GlobalData: |
| 4 | + |
| 5 | + - [Question or Problem?](#question) |
| 6 | + - [Issues and Bugs](#issue) |
| 7 | + - [Feature Requests](#feature) |
| 8 | + - [Submitting a Pull Request](#pullrequest) |
| 9 | + - [Contributor License Agreement](#cla) |
| 10 | + |
| 11 | + |
| 12 | +## <a name="question"></a> Got a Question or Problem? |
| 13 | + |
| 14 | +If you have questions about how to use GlobalData, please read the |
| 15 | +[GlobalData documentation][documentation] or ask on [Stack Overflow][stackoverflow]. There are |
| 16 | +thousands of GlobalData questions on Stack Overflow with the [global-data-csharp][stackoverflow] tag. |
| 17 | + |
| 18 | +GitHub issues are only for [reporting bugs](#issue) and [feature requests](#feature), not |
| 19 | +questions or help. |
| 20 | + |
| 21 | + |
| 22 | +## <a name="issue"></a> Found an Issue? |
| 23 | + |
| 24 | +If you find a bug in the source code or a mistake in the documentation, you can help by |
| 25 | +submitting an issue to the [GitHub Repository][github]. Even better you can submit a Pull Request |
| 26 | +with a fix. |
| 27 | + |
| 28 | +When submitting an issue please include the following information: |
| 29 | + |
| 30 | +- A description of the issue |
| 31 | +- The JSON, classes, and GlobalData code related to the issue |
| 32 | +- The exception message and stacktrace if an error was thrown |
| 33 | +- If possible, please include code that reproduces the issue. [DropBox][dropbox] or GitHub's |
| 34 | +[Gist][gist] can be used to share large code samples, or you could |
| 35 | +[submit a pull request](#pullrequest) with the issue reproduced in a new test. |
| 36 | + |
| 37 | +The more information you include about the issue, the more likely it is to be fixed! |
| 38 | + |
| 39 | + |
| 40 | +## <a name="feature"></a> Want a Feature? |
| 41 | + |
| 42 | +You can request a new feature by submitting an issue to the [GitHub Repository][github]. Before |
| 43 | +requesting a feature consider the following: |
| 44 | + |
| 45 | +- GlobalData has many extensibility points, it is possible you can implement your feature today without |
| 46 | +modifying GlobalData |
| 47 | +- Stability is important. GlobalData is used by thousands of other libraries and features that require |
| 48 | +large breaking changes are unlikely to be accepted |
| 49 | + |
| 50 | + |
| 51 | +## <a name="pullrequest"></a> Submitting a Pull Request |
| 52 | + |
| 53 | +When submitting a pull request to the [GitHub Repository][github] make sure to do the following: |
| 54 | + |
| 55 | +- Check that new and updated code follows GlobalData's existing code formatting and naming standard |
| 56 | +- Run GlobalData's unit tests to ensure no existing functionality has been affected |
| 57 | +- Write new unit tests to test your changes. All features and fixed bugs must have tests to verify |
| 58 | +they work |
| 59 | + |
| 60 | +Read [GitHub Help][pullrequesthelp] for more details about creating pull requests. |
| 61 | + |
| 62 | + |
| 63 | +## <a name="cla"></a> Contributor License Agreement |
| 64 | + |
| 65 | +By contributing your code to GlobalData you grant Azihub (Mason Chase) a non-exclusive, irrevocable, worldwide, |
| 66 | +royalty-free, sublicenseable, transferable license under all of Your relevant intellectual property rights |
| 67 | +(including copyright, patent, and any other rights), to use, copy, prepare derivative works of, distribute and |
| 68 | +publicly perform and display the Contributions on any licensing terms, including without limitation: |
| 69 | +(a) open source licenses like the MIT license; and (b) binary, proprietary, or commercial licenses. Except for the |
| 70 | +licenses granted herein, You reserve all right, title, and interest in and to the Contribution. |
| 71 | + |
| 72 | +You confirm that you are able to grant us these rights. You represent that You are legally entitled to grant the |
| 73 | +above license. If Your employer has rights to intellectual property that You create, You represent that You have |
| 74 | +received permission to make the Contributions on behalf of that employer, or that Your employer has waived such |
| 75 | +rights for the Contributions. |
| 76 | + |
| 77 | +You represent that the Contributions are Your original works of authorship, and to Your knowledge, no other person |
| 78 | +claims, or has the right to claim, any right in any invention or patent related to the Contributions. You also |
| 79 | +represent that You are not legally obligated, whether by entering into an agreement or otherwise, in any way that |
| 80 | +conflicts with the terms of this license. |
| 81 | + |
| 82 | +Azihub (Mason Chase) acknowledges that, except as explicitly described in this Agreement, any Contribution which |
| 83 | +you provide is on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, |
| 84 | +INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS |
| 85 | +FOR A PARTICULAR PURPOSE. |
| 86 | + |
| 87 | + |
| 88 | +[github]: https://github.com/JamesNK/azihub |
| 89 | +[documentation]: https://global-data.azihub.com/help |
| 90 | +[stackoverflow]: https://stackoverflow.com/questions/tagged/global-data-csharp |
| 91 | +[gist]: https://gist.github.com |
| 92 | +[pullrequesthelp]: https://help.github.com/articles/using-pull-requests |
0 commit comments