-
Notifications
You must be signed in to change notification settings - Fork 73
Level up markdown content in all repos in this organization #8
Copy link
Copy link
Closed
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Problem: We say different things in different repositories for items, such as code of conduct, for no good reason.
https://github.com/opensearch-project/job-scheduler
https://github.com/opensearch-project/common-utils
etc.
Let's level up READMEs across the org to at least include standard things.
- Add logo and standard sections in README.md, e.g. inspired from common-utils/README.md, merge with your content.
- Use a standard CONTRIBUTING.md that links to one in this repo.
- Extract DEVELOPER_GUIDE.md, e.g. common-utils/DEVELOPER_GUIDE
- Ensure MAINTAINERS.md, e.g. common-utils/MAINTAINERS.md that links to general maintainer responsibilities.
- Ensure ADMINS.md, e.g. common-utils/ADMINS.md that links to general admin responsibilities.
- Add a standard SECURITY.md, e.g. common-utils/SECURITY.md.
- Add a standard RELEASING.md, e.g. common-utils/RELEASING.md.
- Cleanup TESTING.md if you have one.
- Cleanup any other .md content you have.
Feel free to take freedoms in these files that are specific to your projects where it makes sense. As a rule of thumb, make links for common things across the org into the .github repo, and add the custom things that are only relevant for your project in your own .md's. When in doubt, consider reducing the amount of mental overhead contributors have to have when making PRs across multiple repos in our org.
Example: opensearch-project/common-utils#32
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed

