|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Contributions to libCEED are welcome. |
| 4 | + |
| 5 | +Please use a pull request to the appropriate branch ('maint' for |
| 6 | +backward-compatible bug fixes for the last stable release, 'master' for |
| 7 | +new features and everything else). |
| 8 | + |
| 9 | +Please make your commits well-organized and atomic, using `git rebase |
| 10 | +--interactive` as needed. Open an issue or RFC pull request to discuss |
| 11 | +any significant changes before investing time. Check that the tests |
| 12 | +pass using `make prove` or `make test`. If adding a new feature, please |
| 13 | +add or extend a test so that it is tested. |
| 14 | + |
| 15 | +Write commit messages for a reviewer of your pull request and for a |
| 16 | +future developer (maybe you) that bisects and finds that a bug was |
| 17 | +introduced in your commit. The assumptions that are clear in your head |
| 18 | +right now are likely not. Give credit where credit is due using tags |
| 19 | +such as `Reported-by: Helpful User <[email protected]>`. Please use a |
| 20 | +real name and email for your author information (`git config user.name` |
| 21 | +and `user.email`). |
| 22 | + |
| 23 | +Please avoid "merging from upstream" (like merging 'master' into your |
| 24 | +feature branch) unless there is a specific reason to do so, in which |
| 25 | +case you should explain why in the merge commit. |
| 26 | +[Rationale](https://lwn.net/Articles/328436/) from |
| 27 | +[Junio](https://gitster.livejournal.com/42247.html) and |
| 28 | +[Linus](http://yarchive.net/comp/linux/git_merges_from_upstream.html). |
| 29 | + |
| 30 | +By submitting a pull request, you are affirming the following. |
| 31 | + |
| 32 | +## [Developer's Certificate of Origin 1.1](https://developercertificate.org/). |
| 33 | + |
| 34 | +By making a contribution to this project, I certify that: |
| 35 | + |
| 36 | +(a) The contribution was created in whole or in part by me and I |
| 37 | + have the right to submit it under the open source license |
| 38 | + indicated in the file; or |
| 39 | + |
| 40 | +(b) The contribution is based upon previous work that, to the best |
| 41 | + of my knowledge, is covered under an appropriate open source |
| 42 | + license and I have the right under that license to submit that |
| 43 | + work with modifications, whether created in whole or in part |
| 44 | + by me, under the same open source license (unless I am |
| 45 | + permitted to submit under a different license), as indicated |
| 46 | + in the file; or |
| 47 | + |
| 48 | +(c) The contribution was provided directly to me by some other |
| 49 | + person who certified (a), (b) or (c) and I have not modified |
| 50 | + it. |
| 51 | + |
| 52 | +(d) I understand and agree that this project and the contribution |
| 53 | + are public and that a record of the contribution (including all |
| 54 | + personal information I submit with it, including my sign-off) is |
| 55 | + maintained indefinitely and may be redistributed consistent with |
| 56 | + this project or the open source license(s) involved. |
| 57 | + |
| 58 | + |
0 commit comments