-
Notifications
You must be signed in to change notification settings - Fork 278
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the Readme and contributing guide (#16)
* Updating the Readme.txt file for opensearch-build repository Signed-off-by: Barani <[email protected]> * Updated the CONTRIBUTING.md file to include additional information. Fixed the 'code of conduct' link in Readme.md file Signed-off-by: Barani <[email protected]> * Removing CLA reference in Contributing file. Signed-off-by: Barani <[email protected]> * Updating the CONTRIBUTING.md with the correct branch information Signed-off-by: Barani <[email protected]>
- Loading branch information
Showing
2 changed files
with
78 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,21 +6,57 @@ documentation, we greatly value feedback and contributions from our community. | |
| Please read through this document before submitting any issues or pull requests to ensure we have all the necessary | ||
| information to effectively respond to your bug report or contribution. | ||
|
|
||
|
|
||
| ## Reporting Bugs/Feature Requests | ||
|
|
||
| We welcome you to use the GitHub issue tracker to report bugs or suggest features. | ||
|
|
||
| When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already | ||
| reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: | ||
|
|
||
| * A reproducible test case or series of steps | ||
| * The version of our code being used | ||
| * Any modifications you've made relevant to the bug | ||
| * Anything unusual about your environment or deployment | ||
|
|
||
| - A reproducible test case or series of steps | ||
| - The version of our code being used | ||
| - Any modifications you've made relevant to the bug | ||
| - Anything unusual about your environment or deployment | ||
|
|
||
| ## Sign your work | ||
| 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 | ||
| ``` | ||
| By making a contribution to this project, I certify that: | ||
| (a) The contribution was created in whole or in part by me and I | ||
| have the right to submit it under the open source license | ||
| indicated in the file; or | ||
| (b) The contribution is based upon previous work that, to the best | ||
| of my knowledge, is covered under an appropriate open source | ||
| license and I have the right under that license to submit that | ||
| work with modifications, whether created in whole or in part | ||
| by me, under the same open source license (unless I am | ||
| permitted to submit under a different license), as indicated | ||
| in the file; or | ||
| (c) The contribution was provided directly to me by some other | ||
| person who certified (a), (b) or (c) and I have not modified | ||
| it. | ||
| (d) I understand and agree that this project and the contribution | ||
| are public and that a record of the contribution (including all | ||
| personal information I submit with it, including my sign-off) is | ||
| maintained indefinitely and may be redistributed consistent with | ||
| this project or the open source license(s) involved. | ||
| ``` | ||
| then you just add a line to every git commit message: | ||
| ``` | ||
| Signed-off-by: Bob Sanders <[email protected]> | ||
| ``` | ||
| You can sign off your work easily by adding the configuration in github | ||
| ``` | ||
| git config user.name "Bob Sanders" | ||
| git config user.email "[email protected]" | ||
| ``` | ||
| Then, you could sign off commits automatically by adding `-s` or `-=signoff` parameter to your usual git commits commands. e.g. | ||
| ``` | ||
| git commit -s -m "my first commit" | ||
| ``` | ||
|
|
||
| ## Contributing via Pull Requests | ||
|
|
||
| Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: | ||
|
|
||
| 1. You are working against the latest source on the *main* branch. | ||
|
|
@@ -39,21 +75,20 @@ To send us a pull request, please: | |
| GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and | ||
| [creating a pull request](https://help.github.com/articles/creating-a-pull-request/). | ||
|
|
||
|
|
||
| ## Finding contributions to work on | ||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
| For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
| [email protected] with any additional questions or comments. | ||
|
|
||
|
|
||
| ## Security issue notifications | ||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| ## Licensing | ||
|
|
||
| See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
| See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,41 @@ | ||
| ## My Project | ||
| - [Contributing](#contributing) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Security](#security) | ||
| - [Licensing](#licensing) | ||
| - [Questions](#Questions) | ||
| - [Issues](#Issues) | ||
| - [Copyright](#copyright) | ||
|
|
||
| TODO: Fill this README out! | ||
| # OpenSearch / OpenSearch Dashboards build repository | ||
|
|
||
| Be sure to: | ||
| This repository contains the scripts for building OpenSearch and OpenSearch Dashboards distributions. | ||
|
|
||
| * Change the title in this README | ||
| * Edit your repository description on GitHub | ||
| ## Contributing | ||
|
|
||
| We welcome you to get involved in development, documentation, and testing of the build scripts. | ||
|
|
||
| See our [contribution guidelines](CONTRIBUTING.md) and the [developer guide](DEVELOPER_GUIDE.md) to get started. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted an [Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
|
|
||
| ## Security | ||
|
|
||
| See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. | ||
| 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. | ||
|
|
||
| ## Licensing | ||
|
|
||
| See the [LICENSE](LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
|
|
||
| ## Questions | ||
|
|
||
| If you have any questions, please join our community forum [here](https://discuss.opendistrocommunity.dev/) | ||
|
|
||
| ## Issues | ||
|
|
||
| ## License | ||
| File any issues [here](https://github.com/opensearch-project/opensearch-build/issues). | ||
|
|
||
| This project is licensed under the Apache-2.0 License. | ||
| ## Copyright | ||
|
|
||
| Copyright 2021 OpenSearch Contributors |