Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a support guide #90

Merged
merged 2 commits into from Nov 24, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -41,8 +41,10 @@ On Windows things are a bit more complicated due to the Shunter install process
- [contextify – Specified platform toolset (v110) is not installed or invalid][contextify]


Migration Guide
---------------
Support and Migration
---------------------

Shunter major versions are supported for 6 months after their last release. This means that patch-level changes will be added and bugs will be fixed. We maintain a [support guide](docs/support.md) which documents the major versions and their support levels.

If you're migrating between major versions of Shunter, we maintain a [migration guide](docs/migration/index.md) to help you.

Expand Down
3 changes: 2 additions & 1 deletion docs/developer-guide.md
Expand Up @@ -41,7 +41,7 @@ Issue Tracking

We use [GitHub issues](https://github.com/nature/shunter/issues) to log bugs and feature requests. This is a great place to look if you're interested in working on Shunter.

If you're going to pick up a piece of work, check the comments to make sure nobody else has started on it. If you're going to do it, say so in the issue comments.
If you're going to pick up a piece of work, check the comments to make sure nobody else has started on it. If you're going to do it, say so in the issue comments.

We use labels extensively to categorise issues, so you should be able to find something that suits your mood. We also label [issues that might be a good starting-point](https://github.com/nature/shunter/labels/good-starter-issue) for new developers to the project.

Expand Down Expand Up @@ -92,6 +92,7 @@ To publish a new version of Shunter:
- Switch to the `master` branch, version commits are the only commits that shouldn't be in a pull-request
- Increment either the major, minor, or patch version in [`package.json`](https://github.com/nature/shunter/blob/master/package.json). If you're unsure which, have a chat about it or re-read the semver docs
- Add an entry to [`HISTORY.md`](https://github.com/nature/shunter/blob/master/HISTORY.md) outlining the changes in the new version. Take your time, this log should be useful to developers building with Shunter
- If you're bumping the major version, update both the [migration guide](migration/index.md) and the [support guide](support.md)
- Commit your changes with a message like "Version 1.2.3" – this helps people find version commits in the log
- Tag your newly created commit with the version number. E.g. `git tag 1.2.3`
- Push both the commit and the new tags to origin: `git push && git push --tags`. It's really important to push tags as well!
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Expand Up @@ -7,6 +7,6 @@ For new users, we recommend reading the [Shunter Introduction](introduction.md)

If you're looking for the full documentation, refer to the [API Documentation](usage/index.md).

If you're migrating between major versions of Shunter, we maintain a [migration guide](migration/index.md).
If you're looking for support end dates or migrating between major versions of Shunter, we maintain a [support guide](support.md) and a [migration guide](migration/index.md).

If you're interested in contributing to Shunter, we also maintain a [developer guide](developer-guide.md).
14 changes: 14 additions & 0 deletions docs/support.md
@@ -0,0 +1,14 @@

Support Guide
=============

Shunter major versions are supported for 6 months after their last release, starting from version 3.0. This means that patch-level changes will be added and bugs will be fixed. This guide outlines the end-of-support dates for the various major versions, and the last minor release for that version.

| Major Version | Last Feature Release | Support End Date |
| :------------ | :------------------- | :--------------- |
| 3 | N/A | N/A |
| 2 | 2.2 | 2015-11-10\* |
| 1 | 1.0 | 2015-09-29\* |


\* Versions 1 and 2 of Shunter never had public releases, and so the support end date was immediate.