diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..97891b3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Changelog + +Changelogs are available as part of the releases, see [Releases page](https://github.com/OWASP/owasp-istg/releases). \ No newline at end of file diff --git a/src/01_introduction/roadmap.md b/roadmap.md similarity index 96% rename from src/01_introduction/roadmap.md rename to roadmap.md index b392613..2d7afff 100644 --- a/src/01_introduction/roadmap.md +++ b/roadmap.md @@ -17,11 +17,11 @@ - [x] Meet and sync with other OWASP security testing guide leaders (WSTG, MASTG) - @ project leaders - [x] Prepare task tracking (Git Issues) to enable tracking, distribution and monitoring of tasks - @ project leaders - [x] Gather volunteers and establish project team - @ project leaders, project team -- [ ] **Milestone 3: Baseline Version Released** +- [x] **Milestone 3: Baseline Version Released** - [x] Gather feedback from the project team regarding draft version of the guide - @ project team - [x] Discuss and implement feedback - @ project team - [x] Review changes and, if needed, iteratively repeat the previous steps - @ project leaders, project team - - [ ] Approve and release baseline version - @ project leaders + - [x] Approve and release baseline version - @ project leaders - [ ] **Milestone 4 - n: Continuous Development and Release of Modular Expansions** - [ ] Collect feedback and ideas for expansions; compile a list of technologies that future versions of the guide should cover - @ project leaders, project team - [ ] Prioritize technologies - @ project leaders, core team (feedback of project team welcome) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index bcb5950..9e3786d 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,12 +1,9 @@ # Summary [OWASP IoT Security Testing Guide](./README.md) -[Ackownlegdements](./acknowledgements.md) -[License](./LICENSE.md) # Introduction - [Introduction](./01_introduction/README.md) - - [Roadmap](./01_introduction/roadmap.md) # IoT Security Testing Framework @@ -28,3 +25,5 @@ - [Wireless Interfaces (ISTG-WRLS)](./03_test_cases/wireless_interfaces/README.md) - [User Interfaces (ISTG-UI)](./03_test_cases/user_interfaces/README.md) +[Acknowlegdements](./acknowledgements.md) +[License](./LICENSE.md) diff --git a/versioning.md b/versioning.md new file mode 100644 index 0000000..51f12c6 --- /dev/null +++ b/versioning.md @@ -0,0 +1,22 @@ +# Versioning Guide + +## Version Structure + +The version structure for this project is defined as follows: + +1. **MAJOR version:** Major versions consolidate extensive changes to multiple parts of the guide (e.g., framework changes, multiple new/updated [components / component specializations](./src/02_framework/methodology#structure-of-the-catalog-of-test-cases), greater depth of detail for a considerable amount of test cases). +2. **MINOR version:** Minor versions are released once a [components / component specializations](./src/02_framework/methodology#structure-of-the-catalog-of-test-cases) has been added or extensively updated/refined. +3. **PATCH version:** Patch version releases are used for smaller fixes (bugs, typos, issues). + +Each release will be tagged with a version identifier "*v[MAJOR].[MINOR].[PATCH]*". + + + +## Branch Structure + +The following branch structure has been defined: + +- **main:** Latest release version +- **latest:** Main working branch that includes all finished but unreleased changes +- **istg-[component_id]:** Used for adding/updating parts of [components / component specializations](./src/02_framework/methodology#structure-of-the-catalog-of-test-cases) +- Further branches will be created for individual topics. Self-explanatory names should be used. \ No newline at end of file