Skip to content

Cleanup READMEs.#32

Merged
dblock merged 1 commit intoopensearch-project:mainfrom
dblock:cleanup-readme
Jun 23, 2021
Merged

Cleanup READMEs.#32
dblock merged 1 commit intoopensearch-project:mainfrom
dblock:cleanup-readme

Conversation

@dblock
Copy link
Copy Markdown
Member

@dblock dblock commented Jun 22, 2021

Signed-off-by: dblock dblock@amazon.com

Description

I'd like to make this repo something other plugin repos can inspire themselves from in terms of standard content.

  • Added ADMINS.md documenting admin responsibilities.
  • Standardized CONTRIBUTING.md
  • Added DEVELOPER_GUIDE.md and moved content from README.
  • Linked standard MAINTAINERS.md.
  • Added SECURITY.md.
  • Cleaned up README.

Issues Resolved

[List any issues this PR will resolve]

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

- Added ADMINS.md documenting admin responsibilities.
- Standardized CONTRIBUTING.md
- Added DEVELOPER_GUIDE.md and moved content from README.
- Linked standard MAINTAINERS.md.
- Added SECURITY.md.
- Cleaned up README.
- Added a RELEASING.md.

Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock requested a review from CEHENKLE June 22, 2021 15:27
@dblock
Copy link
Copy Markdown
Member Author

dblock commented Jun 22, 2021

@CEHENKLE and @saratvemulapalli I'd like to use this repo as a sample for other plugin repos in terms of required content. Please take a close look!

Copy link
Copy Markdown
Member

@saratvemulapalli saratvemulapalli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.
Thanks dB!

## Copyright

Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. No newline at end of file
Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious:

  1. Why do we still have 2020? Our project started in 2021...
  2. How should be take care of updating the new year. Eg 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this comes from OpenDistro? @elfisher maybe you know?

@dblock dblock merged commit cfb81ad into opensearch-project:main Jun 23, 2021
wuychn pushed a commit to ochprince/common-utils that referenced this pull request Mar 16, 2023
- Added ADMINS.md documenting admin responsibilities.
- Standardized CONTRIBUTING.md
- Added DEVELOPER_GUIDE.md and moved content from README.
- Linked standard MAINTAINERS.md.
- Added SECURITY.md.
- Cleaned up README.
- Added a RELEASING.md.

Signed-off-by: dblock <dblock@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants