diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22df330959..a1aa3a670c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,8 @@ - [GitHub Flow](#github-flow) - [How to work with GitHub Flow](#how-to-work-with-github-flow) - [Working with Forks and Pull Requests](#working-with-forks-and-pull-requests) - - [Working with Issues / How to Contribute in Issues](#working-with-issues--how-to-contribute-in-issues) + - [Bugfixing and Security Fixing Released Features](#bugfixing-and-security-fixing-released-features) + - [Working with Issues - How to Contribute in Issues](#working-with-issues---how-to-contribute-in-issues) - [How to Write Commit Messages](#how-to-write-commit-messages) - [Code of Conduct](#code-of-conduct) @@ -54,7 +55,21 @@ When you are done, you can convert it to a standard *Pull Request* (or create on Generally the _secureCodeBox_ project follows the standard [GitHub Pull request process](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). -## Working with Issues/How to Contribute in Issues +## Bugfixing and Security Fixing Released Features + +For bugfixes and security fixes of the current release please follow the following workflow: +- For the minor release + - Checkout current minor release branch (e.g. v2.5.x) or create if not existent from latest git tag + - Create a bugfix branch from release branch + - Fix Bug + - Create PR to release branch + - Generate new semver release +- For the main branch: + - Create a bugfix branch from `main` branch + - Cherry-Pick Bugfix and commit to bugfix branch + - Create PR to `main` branch + +## Working with Issues - How to Contribute in Issues It is mandatory to open an issue, if the task takes longer than one hour. Before you open an issue please verify there is no existing one covering your issue. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..163b28fbb4 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,35 @@ +# Security Policy + +## Supported Versions +Our _release cycle_ for new features (minior [semver](https://semver.org/) update) +is roughly every two weeks (we will usually make a new release after each review). + +| Version | Security Fixes* | Supported** | +| ------- | ------------------ | ------------------ | +| 2.6.x-alpha1 | :white_check_mark: | :white_check_mark: | +| 2.5.x | :white_check_mark: | :white_check_mark: | +| <= 2.4.x | :x: | :x: | +| < 2.0 | :x: | :x: | + +### Major Release (Semver) +_Upcoming major updates_ will come with a time window in which both _major versions_ (starting with v2.x.x) +will receive security updates and bugfixes. The concrete support intervall will be probably a couple of months +and will be published when the next major version will be released. + +### Minor Release/Feature Releases (Semver) +We currently plan to provide support for the _latest minor [semver](https://semver.org/)_ release only. + +### Patch Release/Bugfix/Security Fix +We try to make bugfixes and high severity fixes available as patch release for the current minor release +as early as possible. + +## Extended (Enterprise) Support +If you are interested in extended support for older versions with security updates of our project +please get in touch with the project team via Slack or email . + +## Reporting a Vulnerability +You have found a vulnerability in the project that shouldn't be disclosed as public issue before it's fixed? +Please get in touch with the project team via Slack or email . + +You can expect a fast reaction within the next days. +We will keep you updated about the next steps and inform you if the vulnerability is accepted and when its fixed or if its ordeclined somehow.