11# How to Contribute
22
3- Contributions to libCEED are welcome .
4-
3+ Contributions to libCEED are encouraged .
4+ <!-- -
55Please use a pull request to the appropriate branch ('maint' for
66backward-compatible bug fixes for the last stable release, 'master' for
77new features and everything else).
8+ -->
9+ Please make your commits well-organized and
10+ [ atomic] ( https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention ) ,
11+ using ` git rebase --interactive ` as needed. Check that tests
12+ (including "examples") pass using ` make prove-all ` . If adding a new
13+ feature, please add or extend a test so that your new feature is
14+ tested.
15+
16+ In typical development, every commit should compile, be covered by the
17+ test suite, and pass all tests. This improves the efficiency of
18+ reviewing and facilitates use of
19+ [ ` git bisect ` ] ( https://git-scm.com/docs/git-bisect ) .
820
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 .
21+ Open an issue or RFC (request for comments) pull request to discuss
22+ any significant changes before investing time. It is useful to create
23+ a WIP (work in progress) pull request for any long-running development
24+ so that others can be aware of your work and help to avoid creating
25+ merge conflicts .
1426
1527Write commit messages for a reviewer of your pull request and for a
1628future 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 ` ).
29+ introduced in your commit. The assumptions that are clear in your
30+ mind while committing are likely not in the mind of whomever (possibly
31+ you) needs to understand it in the future.
32+
33+ Give credit where credit is due using tags such as `Reported-by:
34+ Helpful User
< [email protected] > `. Please use a real name and email
35+ for your author information (` git config user.name ` and ` user.email ` ).
2236
2337Please avoid "merging from upstream" (like merging 'master' into your
2438feature branch) unless there is a specific reason to do so, in which
@@ -27,6 +41,10 @@ case you should explain why in the merge commit.
2741[ Junio] ( https://gitster.livejournal.com/42247.html ) and
2842[ Linus] ( http://yarchive.net/comp/linux/git_merges_from_upstream.html ) .
2943
44+ You can use ` make style ` to help conform to coding conventions of the
45+ project, but try to avoid mixing whitespace or formatting changes with
46+ content changes (see atomicity above).
47+
3048By submitting a pull request, you are affirming the following.
3149
3250## [ Developer's Certificate of Origin 1.1] ( https://developercertificate.org/ ) .
0 commit comments