diff --git a/README.md b/README.md index 192713e6d3..785d12367d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ Kunstmaan Bundles CMS ===================== -The Kunstmaan Bundles CMS is an advanced yet user-friendly content management system, based on the full stack Symfony -framework combined with a whole host of community bundles. It provides a full featured, multi-language CMS system with +The Kunstmaan Bundles CMS is an advanced yet user-friendly content management system, based on the full stack Symfony +framework combined with a whole host of community bundles. It provides a full featured, multi-language CMS system with an innovative page and form assembling process, versioning, workflow, translation and media managers and much much more. Please refer to the documentation at [https://bundles.kunstmaan.be/documentation](https://bundles.kunstmaan.be/documentation) to get your CMS up and running. @@ -11,9 +11,9 @@ Please refer to the documentation at [https://bundles.kunstmaan.be/documentation ### Contributing -We love contributions! We've provide you with a [Contribution Guide](docs/07-00-contributing.md) to get you started. -If you're submitting a pull request, please follow the guidelines in the [Submitting pull requests](docs/07-02-pull-requests.md) -documentation and be sure to read our [Coding Standards](docs/07-03-coding-standards.md) aswell. +We love contributions! We've provide you with a [Contribution Guide](docs/07-00-contributing.md) to get you started. +If you're submitting a pull request, please follow the guidelines in the [Submitting pull requests](docs/07-02-pull-requests.md) +documentation and be sure to read our [Coding Standards](docs/07-03-coding-standards.md) as well. ### Browser support diff --git a/docs/07-02-pull-requests.md b/docs/07-02-pull-requests.md index 9146c1359c..31813d2c15 100644 --- a/docs/07-02-pull-requests.md +++ b/docs/07-02-pull-requests.md @@ -79,16 +79,16 @@ an existing one for instance), it must also include the following: Whenever you feel that your patch is ready for submission, follow the following steps. -### Select correct branch for pull request +### Select the correct branch for your pull request ``` | Kind of PR | Branch | ------------- | --- -| New feature | master -| BC break | master -| Deprecations | master -| Bug fix | current minor version -| Security fix | current major version +| New feature | master branch +| BC break | master branch +| Deprecations | master branch +| Bug fix | latest minor version branch +| Security fix | first minor version branch (of the latest major version) where the security fix was introduced ``` ### Rebase your pull request diff --git a/docs/07-07-release-process.md b/docs/07-07-release-process.md index 1c265e9d99..d35e417c5a 100644 --- a/docs/07-07-release-process.md +++ b/docs/07-07-release-process.md @@ -1,24 +1,26 @@ # Release process -Regarding our release process, we are implementing a flexible approach with limits. We will also follow the Symfony releases. -This means that we will do a minor/major release when Symfony does. +We are implementing a flexible release process approach with some limitations. We will not follow the same fixed release points as the Symfony project, nor the version numbers, but we try to make the Kunstmaan Bundles CMS compatible with the latest Symfony releases as soon as possible. This means that when a new minor Symfony version gets released, that this version can be used in the next minor release of the Kunstmaan Bundles CMS. A new major Symfony version can be used in the next major release of the CMS. ## Major releases -A major release will be done every 3 to 9 months. This will depend on the submitted BC breaks -on the master branch. When we reach 10 BC breaks, the 9 month limit or Symfony does a major release, than a new release -will be made. - -For our major release we want to implement a feature freeze and will do an RC release first. After a month -we will do a final release. +A major release will be done every 3 to 9 months. This will depend on: +* the number of backwards incompatible submitted pull requests / new features +* the release of a new major Symfony version +For our major releases we want to implement a feature freeze period. We will do this by releasing a release candidate (RC) first. After a month +we will do the final release. During this freeze, only bugfixed will be merged in the release branch. ## Minor releases -A major release will be done every month, if necessary. This depends on the new features that are introduced and when -Symfony does a minor release. - +A minor release will be done when necessary. This will depend on: +* the number of bugfixes +* the number of backwards compatible new features +* the release of a new minor Symfony version ## Patch releases -A patch release will be done every 2 weeks, if necessary. This depends on the bugfixes that are submitted. +A patch release will be done when needed. Some reasons: +* security issue was fixed (in CMS or Symfony) +* a third party library compatibility issue was fixed +* ...