Cleanup READMEs. #32
Merged
Cleanup READMEs. #32
Conversation
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
dblock
force-pushed
the
cleanup-readme
branch
4 times, most recently
from
b02d901
to
308c5a3
Compare
- 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>
|
@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! |
saratvemulapalli
approved these changes
Jun 22, 2021
| Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. |
There was a problem hiding this comment.
Just curious:
- Why do we still have 2020? Our project started in 2021...
- How should be take care of updating the new year. Eg 2022
There was a problem hiding this comment.
I assume this comes from OpenDistro? @elfisher maybe you know?
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Issues Resolved
[List any issues this PR will resolve]
Check List
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.