ASVS v5.0 release checklist - rough workings
Open
Nobody has claimed this yet.
_5.0 - draft
- Dominant language
- HTML
- Stars
- 3.6k
- Forks
- 831
- Avg merge
- 7h 55m
- Merged PRs (30d)
- 4
Description
We need to organize and also identify dependencies/order of performance.
Any other items you can think of @elarlang ?
Task list:
Finalise unordered draft:
- Close all requirement issues.
- Change all levels.
- Change levels to a number rather than tick boxes? (#2560)
Need a script to update this in GitHub from Google Sheets and also update the tags.- This is almost complete manually, as tracked in #2690
- must vs should (#2554)
Reordering document:
- Covered by #2456
- Re-ordering and re-numeration is done, some "just before the release" clean-up tasks to do
Prepare RC1:
- Fix export scripts for new format - Include backwards compatible export formats? For example that makes levels back to tick boxes #3136
- Chapter text (including #1132)
- Update other initial text - Include better explanation of what is in Level 1 #3135, #3134
- Fix things that are not in 3rd person (we, you) #2802
- Check references? #2783
- Update Glossary (#2201)
- Grammar and terminology (#3013, #2390)
- Announce rc1, need to consider what feedback will and won't be accepted?
Final release:
- Review and action RC1 feedback
- Add release strategy to document (a promise to users what is patch release and we don't do breaking changes into it)
- Create a release and release tag in GitHub
- Update readme
- We don't look translations for v4.n anymore
- Align list (order) of project leaders with v5.0.0 Frontispiece
- Align list of working group members with v5.0.0 Frontispiece
- Announce the release date / release
- Update contributors information and working group
Post release:
- Prepare publicity on social and slack
- Update public website
- Update translation instructions
- Write requirements scope explanations
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 reviewing the completed release checklist and the remaining “Write requirements scope explanations” item; the issue names no file or test. Done means adding those explanations and completing the final unchecked task.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100