OpenAPITools / OpenAPITools/openapi-generator
[REQ] Update release information and documentation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
While documentation is readily available information regarding the migration from one version to a newer one got stuck in either the third or fourth release.
It would be helpful to add to this documentation, or directly delete the files if they end up being considered unimportant.
The files mentiones would be the Release Information ond the Migration Guide.
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 docs/release-summary.md and docs/migration-guide.adoc, reviewing the release-to-release migration information they contain. The issue is complete when the missing information is added or the project confirms that the files are unimportant and removes them.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100