opensearch-project / opensearch-project/opensearch-java
[FEATURE] Document the spec-based generation for developers in DEVELOPER_GUIDE.md
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Java
- Stars
- 165
- Forks
- 250
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 26
Description
We are proposing changes to the way we maintain clients, by generating the API methods from a spec. The exact process is still up for debate. This issue a placeholder for the need to update the documentation when https://github.com/opensearch-project/opensearch-java/issues/284 is complete.
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 with DEVELOPER_GUIDE.md and review issue #284, which must be completed before this documentation can be updated. Confirm the spec-based client-generation process and its final implementation details, then document that process for developers in DEVELOPER_GUIDE.md.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100