source: rtems-central/formal/promela/src/src/modules/comment_filter/CONTRIBUTING.md @ 13ed9da

Last change on this file since 13ed9da was 13ed9da, checked in by Andrew Butterfield <Andrew.Butterfield@…>, on 01/13/23 at 15:36:54

forked from https://github.com/quic/comment-filter/commits/master
commit 9cfb52318e5f71af56b5808e280a9b089b9abc32

  • Property mode set to 100644
File size: 3.6 KB
Line 
1## Contributing to Comment Filter
2
3Hi there!
4We’re thrilled that you’d like to contribute to this project.
5Your help is essential for keeping this project great and for making it better.
6
7## Branching Strategy
8
9In general, contributors should develop on branches based off of `master` and pull requests should be made against `master`.
10
11## Submitting a pull request
12
131. Please read our [code of conduct](code-of-conduct.md] and [license](LICENSE.txt).
141. [Fork](https://github.com/codeauroraforum/comment-filter/fork) and clone the repository.
151. Create a new branch based on `master`: `git checkout -b <my-branch-name> master`.
161. Make your changes, add tests, and make sure the tests still pass.
171. Push to your fork and [submit a pull request](https://github.com/codeauroraforum/comment-filter/compare) from your branch to `master`.
181. Pat yourself on the back and wait for your pull request to be reviewed.
19
20Here are a few things you can do that will increase the likelihood of your pull request to be accepted:
21
22- Follow the existing style where possible. We try and adhere to [pep8](https://www.python.org/dev/peps/pep-0008/).
23- Write tests.
24- Keep your change as focused as possible.
25  If you want to make multiple independent changes, please consider submitting them as separate pull requests.
26- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
27
28
29## Developer Certification of Origin (DCO)
30Comment Filter requires the Developer Certificate of Origin (DCO) process to be followed.
31
32The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO, which you can find below or at http://developercertificate.org/.
33
34Comment Filter does not merge any pull requests made until each commit has been signed for the DCO.
35
36```
37Developer Certificate of Origin
38Version 1.1
39
40Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
411 Letterman Drive
42Suite D4700
43San Francisco, CA, 94129
44
45Everyone is permitted to copy and distribute verbatim copies of this
46license document, but changing it is not allowed.
47
48
49Developer's Certificate of Origin 1.1
50
51By making a contribution to this project, I certify that:
52
53(a) The contribution was created in whole or in part by me and I
54    have the right to submit it under the open source license
55    indicated in the file; or
56
57(b) The contribution is based upon previous work that, to the best
58    of my knowledge, is covered under an appropriate open source
59    license and I have the right under that license to submit that
60    work with modifications, whether created in whole or in part
61    by me, under the same open source license (unless I am
62    permitted to submit under a different license), as indicated
63    in the file; or
64
65(c) The contribution was provided directly to me by some other
66    person who certified (a), (b) or (c) and I have not modified
67    it.
68
69(d) I understand and agree that this project and the contribution
70    are public and that a record of the contribution (including all
71    personal information I submit with it, including my sign-off) is
72    maintained indefinitely and may be redistributed consistent with
73    this project or the open source license(s) involved.
74 ```
75
76### DCO commit example
77
78After committing your changes with `git commit -s`, your message should look something like:
79```
80commit 442deae270bf585052be012b064ed92299e221c4
81Author: Random Developer <random@developer.org>
82Date:   Sat Oct 21 08:33:15 2017 -0700
83
84    My example commit message
85
86    Signed-off-by: Random Developer <random@developer.org>
87```
Note: See TracBrowser for help on using the repository browser.