opensearch-project / opensearch-project/.github
Standardize what is published within release notes
Open
Nobody has claimed this yet.
campaign
- Dominant language
- No language data
- Stars
- 41
- Forks
- 74
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 1
Description
Standardize release notes across all products that we release in this org.
- Should one include every PR or remove some?
- Should these be edited to be humanly readable?
- Where can I find the standard format?
- ...
Probably should go into https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the proposed MAINTAINERS.md location and the release notes practices across the products in the organization. Define a standard format and clear guidance on which pull requests to include and how to make entries human-readable. Done means the standard is documented and its location is clear for all releasing projects.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100