|
1 | | -# Contributing Guidelines |
2 | | - |
3 | | -Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional |
4 | | -documentation, we greatly value feedback and contributions from our community. |
5 | | - |
6 | | -Please read through this document before submitting any issues or pull requests to ensure we have all the necessary |
7 | | -information to effectively respond to your bug report or contribution. |
8 | | - |
9 | | - |
10 | | -## Reporting Bugs/Feature Requests |
11 | | - |
12 | | -We welcome you to use the GitHub issue tracker to report bugs or suggest features. |
13 | | - |
14 | | -When filing an issue, please check [existing open](../../issues), or [recently closed](../../issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already |
15 | | -reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: |
16 | | - |
17 | | -* A reproducible test case or series of steps |
18 | | -* The version of our code being used |
19 | | -* Any modifications you've made relevant to the bug |
20 | | -* Anything unusual about your environment or deployment |
21 | | - |
22 | | - |
23 | | -## Contributing via Pull Requests |
24 | | -Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: |
25 | | - |
26 | | -1. You are working against the latest source on the *master* branch. |
27 | | -2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. |
28 | | -3. You open an issue to discuss any significant work - we would hate for your time to be wasted. |
29 | | - |
30 | | -To send us a pull request, please: |
31 | | - |
32 | | -1. Fork the repository. |
33 | | -2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. |
34 | | -3. Ensure local tests pass. |
35 | | -4. Commit to your fork using clear commit messages. |
36 | | -5. Send us a pull request, answering any default questions in the pull request interface. |
37 | | -6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. |
38 | | - |
39 | | -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and |
40 | | -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). |
41 | | - |
42 | | - |
43 | | -## Finding contributions to work on |
44 | | -Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](../../labels/help%20wanted) issues is a great place to start. |
45 | | - |
46 | | - |
47 | | -## Code of Conduct |
48 | | - |
49 | | -Please refer to [Code of Conduct](./CODE_OF_CONDUCT.md) on this repository. |
50 | | - |
51 | | - |
52 | | -## Developer Certificate of Origin |
53 | | - |
54 | | -OpenSearch is an open source product released under the Apache 2.0 license (see either [the Apache site](https://www.apache.org/licenses/LICENSE-2.0) or the [LICENSE.txt file](./LICENSE.txt)). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software. |
55 | | - |
56 | | -We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that. |
57 | | - |
58 | | -The DCO is a declaration 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 [DeveloperCertificate.org](http://developercertificate.org/). |
59 | | - |
60 | | -``` |
61 | | -Developer's Certificate of Origin 1.1 |
62 | | -
|
63 | | -By making a contribution to this project, I certify that: |
64 | | -
|
65 | | -(a) The contribution was created in whole or in part by me and I |
66 | | - have the right to submit it under the open source license |
67 | | - indicated in the file; or |
68 | | -
|
69 | | -(b) The contribution is based upon previous work that, to the |
70 | | - best of my knowledge, is covered under an appropriate open |
71 | | - source license and I have the right under that license to |
72 | | - submit that work with modifications, whether created in whole |
73 | | - or in part by me, under the same open source license (unless |
74 | | - I am permitted to submit under a different license), as |
75 | | - Indicated in the file; or |
76 | | -
|
77 | | -(c) The contribution was provided directly to me by some other |
78 | | - person who certified (a), (b) or (c) and I have not modified |
79 | | - it. |
80 | | -
|
81 | | -(d) I understand and agree that this project and the contribution |
82 | | - are public and that a record of the contribution (including |
83 | | - all personal information I submit with it, including my |
84 | | - sign-off) is maintained indefinitely and may be redistributed |
85 | | - consistent with this project or the open source license(s) |
86 | | - involved. |
87 | | - ``` |
88 | | -We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms. |
89 | | - |
90 | | -Each commit must include a DCO which looks like this |
91 | | - |
92 | | -``` |
93 | | -Signed-off-by: Jane Smith <jane.smith@email.com> |
94 | | -``` |
95 | | -You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message. |
96 | | - |
97 | | -## Security issue notifications |
98 | | - |
99 | | -If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. |
100 | | - |
101 | | - |
102 | | -## Licensing |
103 | | - |
104 | | -See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution. |
| 1 | +## Contributing to this Project |
105 | 2 |
|
| 3 | +OpenSearch is a community project that is built and maintained by people just like **you**. |
| 4 | +[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects. |
0 commit comments