|
1 | | -# Contributing Guidelines |
| 1 | +## Contributing to this Project |
2 | 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 | | -## Reporting Bugs/Feature Requests |
10 | | - |
11 | | -We welcome you to use the GitHub issue tracker to report bugs or suggest features. |
12 | | - |
13 | | -When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already |
14 | | -reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: |
15 | | - |
16 | | -- A reproducible test case or series of steps |
17 | | -- The version of our code being used |
18 | | -- Any modifications you've made relevant to the bug |
19 | | -- Anything unusual about your environment or deployment |
20 | | - |
21 | | -## Sign your work |
22 | | -The sign-off is a simple line at the end of each commit, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. if you can certify the below |
23 | | -``` |
24 | | -By making a contribution to this project, I certify that: |
25 | | -(a) The contribution was created in whole or in part by me and I |
26 | | -have the right to submit it under the open source license |
27 | | -indicated in the file; or |
28 | | -(b) The contribution is based upon previous work that, to the best |
29 | | -of my knowledge, is covered under an appropriate open source |
30 | | -license and I have the right under that license to submit that |
31 | | -work with modifications, whether created in whole or in part |
32 | | -by me, under the same open source license (unless I am |
33 | | -permitted to submit under a different license), as indicated |
34 | | -in the file; or |
35 | | -(c) The contribution was provided directly to me by some other |
36 | | -person who certified (a), (b) or (c) and I have not modified |
37 | | -it. |
38 | | -(d) I understand and agree that this project and the contribution |
39 | | -are public and that a record of the contribution (including all |
40 | | -personal information I submit with it, including my sign-off) is |
41 | | -maintained indefinitely and may be redistributed consistent with |
42 | | -this project or the open source license(s) involved. |
43 | | -``` |
44 | | -then you just add a line to every git commit message: |
45 | | -``` |
46 | | -Signed-off-by: Bob Sanders <bob.sanders@email.com> |
47 | | -``` |
48 | | -You can sign off your work easily by adding the configuration in github |
49 | | -``` |
50 | | -git config user.name "Bob Sanders" |
51 | | -git config user.email "bob.sanders@email.com" |
52 | | -``` |
53 | | -Then, you could sign off commits automatically by adding `-s` or `-=signoff` parameter to your usual git commits commands. e.g. |
54 | | -``` |
55 | | -git commit -s -m "my first commit" |
56 | | -``` |
57 | | - |
58 | | -## Contributing via Pull Requests |
59 | | - |
60 | | -Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: |
61 | | - |
62 | | -1. You are working against the latest source on the *main* branch. |
63 | | -2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. |
64 | | -3. You open an issue to discuss any significant work - we would hate for your time to be wasted. |
65 | | - |
66 | | -To send us a pull request, please: |
67 | | - |
68 | | -1. Fork the repository. |
69 | | -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. |
70 | | -3. Ensure local tests pass. |
71 | | -4. Commit to your fork using clear commit messages. |
72 | | -5. Send us a pull request, answering any default questions in the pull request interface. |
73 | | -6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. |
74 | | - |
75 | | -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and |
76 | | -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). |
77 | | - |
78 | | -## Finding contributions to work on |
79 | | - |
80 | | -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' issues is a great place to start. |
81 | | - |
82 | | -## Code of Conduct |
83 | | - |
84 | | -This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). |
85 | | -For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact |
86 | | -opensource-codeofconduct@amazon.com with any additional questions or comments. |
87 | | - |
88 | | -## Security issue notifications |
89 | | - |
90 | | -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. |
91 | | - |
92 | | -## Licensing |
93 | | - |
94 | | -See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. |
| 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