|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +This document contains information and guidelines about contributing to this project. |
| 4 | +Please read it before you start participating. |
| 5 | + |
| 6 | +**Topics** |
| 7 | + |
| 8 | +* [Pull Request Submissions](#pull-request-submissions) |
| 9 | +* [Asking Questions](#asking-questions) |
| 10 | +* [Reporting Security Issues](#reporting-security-issues) |
| 11 | +* [Reporting Issues](#reporting-other-issues) |
| 12 | +* [Developers Certificate of Origin](#developers-certificate-of-origin) |
| 13 | +* [Code of Conduct](#code-of-conduct) |
| 14 | + |
| 15 | +<a href="#pull-request-submissions"></a> |
| 16 | +## Pull Request Submissions. |
| 17 | + |
| 18 | +All pull requests should be made to the development branch. Details should be available describing your fix. Before submitting a pull request, please confirm that merge issues are resolved. |
| 19 | + |
| 20 | +<a href="#asking-questions"></a> |
| 21 | +## Asking Questions |
| 22 | + |
| 23 | +We don't use GitHub as a support forum. |
| 24 | +For any usage questions that are not specific to the project itself, |
| 25 | +please ask on [Stack Overflow](http://stackoverflow.com/questions/tagged/cosmicmind) instead. |
| 26 | +By doing so, you'll be more likely to quickly solve your problem, |
| 27 | +and you'll allow anyone else with the same question to find the answer. |
| 28 | +This also allows maintainers to focus on improving the project for others. |
| 29 | + |
| 30 | +<a href="#reporting-security-issues"></a> |
| 31 | +## Reporting Security Issues |
| 32 | + |
| 33 | +CosmicMind takes security seriously. |
| 34 | +If you discover a security issue, please bring it to our attention right away! |
| 35 | + |
| 36 | +Please **DO NOT** file a public issue, |
| 37 | +instead send your report privately to <[email protected]>. |
| 38 | +This will help ensure that any vulnerabilities that _are_ found |
| 39 | +can be [disclosed responsibly](http://en.wikipedia.org/wiki/Responsible_disclosure) |
| 40 | +to any affected parties. |
| 41 | + |
| 42 | +<a href="#reporting-other-issues"></a> |
| 43 | +## Reporting Other Issues |
| 44 | + |
| 45 | +A great way to contribute to the project |
| 46 | +is to send a detailed issue when you encounter an problem. |
| 47 | +We always appreciate a well-written, thorough bug report. |
| 48 | + |
| 49 | +Check that the project issues database |
| 50 | +doesn't already include that problem or suggestion before submitting an issue. |
| 51 | +If you find a match, add a quick "+1" or "I have this problem too." |
| 52 | +Doing this helps prioritize the most common problems and requests. |
| 53 | + |
| 54 | +When reporting issues, please include the following: |
| 55 | + |
| 56 | +* The version of Xcode you're using |
| 57 | +* The version of iOS you're targeting |
| 58 | +* The full output of any stack trace or compiler error |
| 59 | +* A code snippet that reproduces the described behavior, if applicable |
| 60 | +* Any other details that would be useful in understanding the problem |
| 61 | + |
| 62 | +This information will help us review and fix your issue faster. |
| 63 | + |
| 64 | +<a href="#developers-certificate-of-origin"></a> |
| 65 | +## Developer's Certificate of Origin 1.1 |
| 66 | + |
| 67 | +By making a contribution to this project, I certify that: |
| 68 | + |
| 69 | +- (a) The contribution was created in whole or in part by me and I |
| 70 | + have the right to submit it under the open source license |
| 71 | + indicated in the file; or |
| 72 | + |
| 73 | +- (b) The contribution is based upon previous work that, to the best |
| 74 | + of my knowledge, is covered under an appropriate open source |
| 75 | + license and I have the right under that license to submit that |
| 76 | + work with modifications, whether created in whole or in part |
| 77 | + by me, under the same open source license (unless I am |
| 78 | + permitted to submit under a different license), as indicated |
| 79 | + in the file; or |
| 80 | + |
| 81 | +- (c) The contribution was provided directly to me by some other |
| 82 | + person who certified (a), (b) or (c) and I have not modified |
| 83 | + it. |
| 84 | + |
| 85 | +- (d) I understand and agree that this project and the contribution |
| 86 | + are public and that a record of the contribution (including all |
| 87 | + personal information I submit with it, including my sign-off) is |
| 88 | + maintained indefinitely and may be redistributed consistent with |
| 89 | + this project or the open source license(s) involved. |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +*Some of the ideas and wording for the statements above were based on work by the [Alamofire](https://github.com/Alamofire/Alamofire/blob/master/CONTRIBUTING.md), [Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md) and [Linux](http://elinux.org/Developer_Certificate_Of_Origin) communities. We commend them for their efforts to facilitate collaboration in their projects.* |
0 commit comments