|
| 1 | +# Contribution Guide |
| 2 | + |
| 3 | +We welcome and encourage community contributions to hpecp-python-library. |
| 4 | + |
| 5 | +## Contributing |
| 6 | + |
| 7 | +The best way to directly collaborate with the project contributors is through GitHub: <https://github.com/hpe-container-platform-community/hpecp-python-library> |
| 8 | + |
| 9 | +* If you want to contribute to our code by either fixing a problem or creating a new feature, please open a GitHub pull request. |
| 10 | +* If you want to raise an issue such as a defect, an enhancement request or a general issue, please open a GitHub issue. |
| 11 | + |
| 12 | +Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. |
| 13 | + |
| 14 | +Note that all patches from all contributors get reviewed. |
| 15 | +After a pull request is made, other contributors will offer feedback. If the patch passes review, a maintainer will accept it with a comment. |
| 16 | +When a pull request fails review, the author is expected to update the pull request to address the issue until it passes review and the pull request merges successfully. |
| 17 | + |
| 18 | +At least one review from a maintainer is required for all patches. |
| 19 | + |
| 20 | +### Developer's Certificate of Origin |
| 21 | + |
| 22 | +All contributions must include acceptance of the DCO: |
| 23 | + |
| 24 | +> Developer Certificate of Origin Version 1.1 |
| 25 | +> |
| 26 | +> Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 660 |
| 27 | +> York Street, Suite 102, San Francisco, CA 94110 USA |
| 28 | +> |
| 29 | +> Everyone is permitted to copy and distribute verbatim copies of this |
| 30 | +> license document, but changing it is not allowed. |
| 31 | +> |
| 32 | +> Developer's Certificate of Origin 1.1 |
| 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 have |
| 37 | +> the right to submit it under the open source license indicated in the |
| 38 | +> file; or |
| 39 | +> |
| 40 | +> \(b) The contribution is based upon previous work that, to the best of my |
| 41 | +> knowledge, is covered under an appropriate open source license and I |
| 42 | +> have the right under that license to submit that work with |
| 43 | +> modifications, whether created in whole or in part by me, under the same |
| 44 | +> open source license (unless I am permitted to submit under a different |
| 45 | +> license), as indicated in the file; or |
| 46 | +> |
| 47 | +> \(c) The contribution was provided directly to me by some other person |
| 48 | +> who certified (a), (b) or (c) and I have not modified it. |
| 49 | +> |
| 50 | +> \(d) I understand and agree that this project and the contribution are |
| 51 | +> public and that a record of the contribution (including all personal |
| 52 | +> information I submit with it, including my sign-off) is maintained |
| 53 | +> indefinitely and may be redistributed consistent with this project or |
| 54 | +> the open source license(s) involved. |
| 55 | +
|
| 56 | +### Sign your work |
| 57 | + |
| 58 | +To accept the DCO, simply add this line to each commit message with your |
| 59 | +name and email address (git commit -s will do this for you): |
| 60 | + |
| 61 | + Signed-off-by: Jane Example <[email protected]> |
| 62 | + |
| 63 | +For legal reasons, no anonymous or pseudonymous contributions are |
| 64 | +accepted. |
| 65 | + |
| 66 | +## Submitting Code Pull Requests |
| 67 | + |
| 68 | +We encourage and support contributions from the community. No fix is too |
| 69 | +small. We strive to process all pull requests as soon as possible and |
| 70 | +with constructive feedback. If your pull request is not accepted at |
| 71 | +first, please try again after addressing the feedback you received. |
| 72 | + |
| 73 | +To make a pull request you will need a GitHub account. For help, see |
| 74 | +GitHub's documentation on forking and pull requests. |
0 commit comments