diff --git a/README.md b/README.md index 8e5c3d0ac6..192713e6d3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ Kunstmaan Bundles CMS ===================== -The Kunstmaan Bundles CMS is an advanced yet user-friendly content management system, based on the full stack Symfony2 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. +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. ![Screenshot](https://bundles.kunstmaan.be/bundles/kunstmaanbundlewebsite/img/general/content-management-system-kunstmaan.jpg) +### 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. + ### Browser support We support at least the 2 last versions of Chrome / Firefox / Safari and IE9 or up. We also support the most current mobile browsers. diff --git a/docs/07-00-contributing.md b/docs/07-00-contributing.md index e90a685a00..283836e00e 100644 --- a/docs/07-00-contributing.md +++ b/docs/07-00-contributing.md @@ -5,4 +5,4 @@ We follow most of the procedures for contributions from the [Symfony](http://sym * [Reporting a bug or a security issue](./07-01-reporting-issues.md) * [Submitting pull requests](./07-02-pull-requests.md) * [Coding standards](./07-03-coding-standards.md) -* [Preparing a new release](./07-04-preparing-a-new-release.md) +* [Release process](./07-07-release-process.md) diff --git a/docs/07-02-pull-requests.md b/docs/07-02-pull-requests.md index 651c5f073f..9146c1359c 100644 --- a/docs/07-02-pull-requests.md +++ b/docs/07-02-pull-requests.md @@ -79,6 +79,18 @@ 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 + +``` +| Kind of PR | Branch +| ------------- | --- +| New feature | master +| BC break | master +| Deprecations | master +| Bug fix | current minor version +| Security fix | current major version +``` + ### Rebase your pull request Before submitting your pull request, update your branch (needed if it takes you a diff --git a/docs/07-07-release-process.md b/docs/07-07-release-process.md new file mode 100644 index 0000000000..1c265e9d99 --- /dev/null +++ b/docs/07-07-release-process.md @@ -0,0 +1,24 @@ +# 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. + +## 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. + + +## 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. + + +## Patch releases + +A patch release will be done every 2 weeks, if necessary. This depends on the bugfixes that are submitted.