Merge pull request #8 from rsps/improve-docs

Improve docs

Author: kernelguy

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# CMake Scripts Code of Conduct
+
+You can find the code of conduct in the [official documentation](https://rsps.github.io/cmake-scripts/current/code_of_conduct.html).

.github/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# CMake Scripts Contribution Guide
+
+The contribution guide is located in the [official documentation](https://rsps.github.io/cmake-scripts/current/contribution_guide.html).

.github/ISSUE_TEMPLATE/defect-report.md

@@ -0,0 +1,41 @@
+---
+name: Bug or Defect report
+about: Report a bug or defect
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## To Reproduce**
+
+_Steps to reproduce the behavior:_
+1. Import module xyz...
+2. Call function with parameters ...
+4. See error
+
+## Expected behavior
+
+_A clear and concise description of what you expected to happen._
+
+## Possible solution
+
+_How could this defect be resolved (if you are able to provide such)_
+
+## Affected version(s)
+_The affected version(s) of this project._
+- Version [e.g. 1.1.0]
+
+## CMake Version
+_The CMake version used, in which the bug or defect was encountered_
+- Version [e.g. 3.30.0]
+
+## OS
+
+_The operating system you used._
+- E.g. Ubuntu 24.04
+
+## Additional context
+
+_Add any other context about the bug or defect..._
+

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,12 @@
+---
+name: Feature Request
+about: Ask for a new or change of an existing feature
+---
+
+## Description
+
+_What is the main purpose of the requested feature or change, e.g. what problem or challenge should to solve?... and why?_
+
+## Possible solution
+
+_How should the feature be implemented?_

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+_A short summary of what does this PR fixes, changes or adds..._
+
+## Details
+
+_More details about the PR... Delete this section, if not need!_
+
+## References
+
+* [Reference to issue(s)](www.google.com)

CHANGELOG.md

@@ -22,5 +22,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * `tests.yaml` and `deploy-docs.yaml` GitHub Actions workflows.
 * `composer.json` to install [Daux.io](https://daux.io) dev-dependency (_documentation generator_).
 * "rsp" theme for Daux (_placed in `resources/daux/themes/rsp`_).
+* Support Policy, Code of Conduct, Contribution Guide and Security Policy in the docs.
+* Defect and Feature Request issue templates (_for GitHub_).
+* Pull request template (_for GitHub_).
 
 [Unreleased]: https://github.com/rsps/cmake-scripts/compare/develop

SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+The security policy can be found in the [official documentation](https://rsps.github.io/cmake-scripts/current/security_policy.html).

cmake/rsp/testing.cmake

@@ -69,7 +69,7 @@ if (NOT COMMAND "define_test_suite")
     #
     # @see end_test_case()
     #
-    # @param <string> name              Human readable name of test suite TODO: Can this be used for ctest labels / groups?
+    # @param <string> name              Human readable name of test suite
     # @param DIRECTORY <path>           Path to directory that contains test-cases
     # @param [MATCH <glob>]             Glob used to match test-case files.
     #                                   Defaults to "*_test.cmake".

cmake/rsp/testing/asserts.cmake

@@ -171,7 +171,7 @@ endif ()
 
 if (NOT COMMAND "assert_in_list")
 
-    #! assert_in_list : Assert key (value) to be inlist
+    #! assert_in_list : Assert key (value) to be in given list
     #
     # @see https://cmake.org/cmake/help/latest/command/if.html#in-list
     #
@@ -196,7 +196,7 @@ endif ()
 
 if (NOT COMMAND "assert_not_in_list")
 
-    #! assert_not_in_list : Assert key (value) not to be inlist
+    #! assert_not_in_list : Assert key (value) not to be in given list
     #
     # @see https://cmake.org/cmake/help/latest/command/if.html#in-list
     #

docs/+current/01_release-notes.md

@@ -11,9 +11,95 @@ author: RSP Systems A/S
 
 ## Support Policy
 
-_TODO: ...incomplete, please review documentation at a later point_
+The following shows the supported versions of the "CMake Scripts" project.
+
+| Version | CMake       | Release | Security Fixes Until |
+|---------|-------------|---------|----------------------|
+| `1.x`   | `3.30 - ?`  | _TBD_   | _TBD_                |
+| `0.x`*  | `3.30 - ? ` | _TBD_   | _N/A_                |
+
+_* - current supported version._ \
+_TBD - "To be decided"._ \
+_N/A - "Not available"._
 
 ## `v0.x` Highlights
 
-_TODO: ...incomplete, please review documentation at a later point_
+### "Mini" Testing Framework
+
+(_available since `v0.1`_)
+
+A "mini" testing framework for testing your CMake modules and scripts.
+
+```cmake
+define_test("has built assets" "has_built_assets")
+function(has_built_assets)
+    assert_file_exists("resources/images/menu_bg.png" MESSAGE "No menu bg")
+    assert_file_exists("resources/images/bg.png" MESSAGE "No background")
+    
+    # ...etc
+endfunction()
+```
+
+See [testing module](./modules/testing/cmake/index.md) for additional information.
+
+### Git
+
+(_available since `v0.1`_)
+
+Git related utilities.
+
+```cmake
+git_find_version_tag(
+    OUTPUT version
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+message("${version}") # 1.15.2
+```
+
+See [git module](./modules/git/index.md) for additional information.
+
+### Version
+
+(_available since `v0.1`_)
+
+Helpers for dealing with a project’s versioning
+
+```cmake
+version_from_file(
+    FILE "version"
+    OUTPUT my_package
+)
+
+message("${my_package}_SEMVER") # 2.0.0-beta.3+AF1004
+```
+
+See [version module](./modules/version/index.md) for additional information.
+
+### Cache
+
+(_available since `v0.1`_)
+
+Module that offers additional caching functionality (_via CMake’s Cache Entry mechanism_).
+
+```cmake
+cache_set(
+    KEY foo
+    VALUE "bar"
+    TTL 5
+)
+
+# ... Elsewhere in your cmake scripts, 5 seconds later...
+
+cache_get(KEY foo)
+
+message("${foo}") # (empty string)
+```
+
+See [cache module](./modules/cache/index.md) for additional information.
+
+## Changelog
+
+For additional information about the latest release, new features, changes or defect fixes, please review the
+[Changelog](https://github.com/rsps/cmake-scripts/blob/main/CHANGELOG.md).