ipspace Creating release notes
- Use docs/release/release.template as a template
- Use other files in the docs/release folder as guidance
- Create release notes from commits after the last
release_xx.xxtag - Categorize commits without the explicit category (usually 'Doc' or 'Fix') in the title into one of the categories based on their content and impact.
- Try to identify breaking changes.
- Remove PR references from all sections except bug and documentation fixes (older release notes/templates may still show the previous style; follow this rule going forward).
- Remove the "Doc: " or "Fix: " part of the commit title
IMPORTANT
- DO NOT make up cross-reference anchors. Use only anchors already defined in the documentation files. Tell the user if you think something is crucial enough to warrant a new anchor.
- DO NOT modify files outside the ‘docs’ directory. For example, DO NOT change the
netsim/__init__.pyfile.