|
| 1 | +## Contributing to the Nimbella Plugin for Netlify |
| 2 | + |
| 3 | +This document outlines the process for contributing to the Nimbella Plugin for Netlify. It also provides some specific guidance for code contributions. |
| 4 | + |
| 5 | +- We have a [Code of Conduct](CODE_OF_CONDUCT.md), please review it so you are familiar with the project values. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +### Issues |
| 10 | + |
| 11 | +The easiest way to contribute is to open an issue with a bug report or a suggestion for improvement. We do not have a prescriptive issue template. We merely request that you take the time to communicate clearly so that we can understand what is being requested and respond appropriately. |
| 12 | + |
| 13 | +- For bug reports, give as much detail as you can about exactly what you were doing when the problem occurred and use transcripts or screen shots to show the problematic behavior. |
| 14 | +- For enhancement requests, give the context. Ideally, explain why the Nimbella community would be interested in the improvement. Then, be as explicit as you can about how you see the change looking and behaving. |
| 15 | +- Check other open issues and add comments to existing issues rather than creating duplicates. |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +### Contributions of source code |
| 20 | + |
| 21 | +All such contributions should be in the form of pull requests. The exact format of the pull request description is not important but it should include |
| 22 | + |
| 23 | +- _motivation_: what problem the contribution is trying to solve and why it should be regarded as helpful |
| 24 | +- _externals_: what visible changes to the behavior of the plugin will occur if the pull request is merged |
| 25 | +- (optionally) _internals_: anything that will help orient a reviewer in reading the code. |
| 26 | + |
| 27 | +By opening a pull request |
| 28 | + |
| 29 | +- You agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE). |
| 30 | +- When you open a pull request with your contributions, **you are certifying that you wrote the code** in the corresponding patch pursuant to the [Developer Certificate of Origin](#developer-certificate-of-origin) included below for your reference. |
| 31 | +- You must conform to our style guidelines and tests must all pass. Issue `npm run lint` and fix any errors or warnings before submitting. A pre-commit hook is configured to run all tests. |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +### Contact us. |
| 36 | + |
| 37 | +We're always happy to help you with any issues you encounter. You may want to [join our Slack community](https://nimbella-community.slack.com/) to engage with us for a more rapid response. |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +### Developer Certificate of Origin |
| 42 | + |
| 43 | +``` |
| 44 | +Developer Certificate of Origin |
| 45 | +Version 1.1 |
| 46 | +
|
| 47 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 48 | +1 Letterman Drive |
| 49 | +Suite D4700 |
| 50 | +San Francisco, CA, 94129 |
| 51 | +
|
| 52 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 53 | +license document, but changing it is not allowed. |
| 54 | +
|
| 55 | +
|
| 56 | +Developer's Certificate of Origin 1.1 |
| 57 | +
|
| 58 | +By making a contribution to this project, I certify that: |
| 59 | +
|
| 60 | +(a) The contribution was created in whole or in part by me and I |
| 61 | + have the right to submit it under the open source license |
| 62 | + indicated in the file; or |
| 63 | +
|
| 64 | +(b) The contribution is based upon previous work that, to the best |
| 65 | + of my knowledge, is covered under an appropriate open source |
| 66 | + license and I have the right under that license to submit that |
| 67 | + work with modifications, whether created in whole or in part |
| 68 | + by me, under the same open source license (unless I am |
| 69 | + permitted to submit under a different license), as indicated |
| 70 | + in the file; or |
| 71 | +
|
| 72 | +(c) The contribution was provided directly to me by some other |
| 73 | + person who certified (a), (b) or (c) and I have not modified |
| 74 | + it. |
| 75 | +
|
| 76 | +(d) I understand and agree that this project and the contribution |
| 77 | + are public and that a record of the contribution (including all |
| 78 | + personal information I submit with it, including my sign-off) is |
| 79 | + maintained indefinitely and may be redistributed consistent with |
| 80 | + this project or the open source license(s) involved. |
| 81 | +``` |
0 commit comments