-
Notifications
You must be signed in to change notification settings - Fork 271
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 <bbarani@amazon.com> * Updated the CONTRIBUTING.md file to include additional information. Fixed the 'code of conduct' link in Readme.md file Signed-off-by: Barani <bbarani@amazon.com> * Removing CLA reference in Contributing file. Signed-off-by: Barani <bbarani@amazon.com> * Updating the CONTRIBUTING.md with the correct branch information Signed-off-by: Barani <bbarani@amazon.com>
- 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
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 |