owncloud / owncloud/docs.owncloud.com
ocis: Document our interpretation of Semver
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 0
- Forks
- 2
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 37
Description
Migrated from owncloud/docs-ocis#778 — opened by @micbar on 2024-04-11.
Original: https://github.com/owncloud/docs-ocis/issues/778
Description
We do Semver
SemVer itself only talks about APIs.
This leaves some room for interpretation, which can create confusion and uncertainty.
Tasks
We need to document how we realize Semver.
Original comments
@mmattel — 2024-04-12
We should note that info in the readme of the ocis repo first and then copy to where ever it is necessary in the admin docs. The information must be consistent on both sides.
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 reading the SemVer specification linked in the issue and the ownCloud/ocis README. Identify how ocis currently interprets versioning, then document that interpretation in the README and copy consistent guidance into the relevant admin documentation. Done means both locations explain the same SemVer policy.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100