ansys / ansys/pyansys-dev-guide

Clarify semantic versioning approach

Open
#552 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
41
Forks
9
Avg merge
11h 24m
Merged PRs (30d)
12

Description

As raised in the PyAnsys dev meeting, we should clarify that we are following Semantic versioning for our PyAnsys packages. We are also mentioning that we are following what other major players are doing... and they are not actually following SemVer. That statament should be removed.

Overall, we might want to rewrite that section for major clarification. See https://dev.docs.pyansys.com/how-to/releasing.html#semantic-versioning

Contributor guide

Open the contributing guide

Research direction

Start with the Semantic Versioning section at https://dev.docs.pyansys.com/how-to/releasing.html#semantic-versioning and compare its claims with the issue description. Remove the statement about following what other major players do, clarify that PyAnsys packages follow Semantic Versioning, and ensure the section reads consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.