From 96dfd12f1a1a87365b2708be753bcb0c2cd89055 Mon Sep 17 00:00:00 2001 From: Athitya Date: Sat, 21 Oct 2017 02:24:11 +0530 Subject: [PATCH] Adds few templates and release policy --- ISSUE_TEMPLATE.md | 12 ++++++++++++ PULL_REQUEST_TEMPLATE.md | 24 +++++++++--------------- RELEASE_POLICY.md | 20 ++++++++++++++++++++ 3 files changed, 41 insertions(+), 15 deletions(-) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 RELEASE_POLICY.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..26e6fe9 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,12 @@ +### Description + +Thanks for opening this issue. Add a brief description of what this issue is, and how to recreate it. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to showcase the issue. + +- Relevant Issues : (none) +- Relevant PRs : (none) +- Type of issue : + - [ ] Installation + - [ ] Font-related + - [ ] Feature request + - [ ] Bug in existing feature + - [ ] Developer mode : Code quality / Tests / Documentation diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index e0abe2e..12a0096 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,12 @@ ### Description -<-- A brief description of what this Pull Request does. Do tag the relevant issue(s) and PR(s) below. --> +Thanks for contributing this Pull Request. Add a brief description of what this Pull Request does. Do tag the relevant issue(s) and PR(s) below. If required, add some screenshot(s) to support your changes. -- Relevant Issues : -- Relevant PRs : - -### Screenshots - -<-- Some screenshot(s) to support your changes. --> - -### Type of change - -- [ ] New feature -- [ ] Bug fix for existing feature -- [ ] Code quality improvement -- [ ] Addition or Improvement of tests -- [ ] Addition or Improvement of documentation +- Relevant Issues : (none) +- Relevant PRs : (none) +- Type of change : + - [ ] New feature + - [ ] Bug fix for existing feature + - [ ] Code quality improvement + - [ ] Addition or Improvement of tests + - [ ] Addition or Improvement of documentation diff --git a/RELEASE_POLICY.md b/RELEASE_POLICY.md new file mode 100644 index 0000000..bab3e32 --- /dev/null +++ b/RELEASE_POLICY.md @@ -0,0 +1,20 @@ +# Release Policy + +Applicable from colorls v1.0.0 onwards + +### Versioning + +Colorls follows semantic versioning whereby the version number is always in the form MAJOR.MINOR.PATCH + +- Patch bump : Bug fixes +- Minor bump : New features (with backwards compatibility) +- Major bump : API breaking changes + +For Major and Minor bumps release candidates should be released around 2 weeks prior to the bump and are indicated by MAJOR.MINOR.0.rc. + +For more information see the full semantic versioning specification at http://semver.org/. + +### Release Timing + +Patch releases should be done after every fix of a major bug (as tagged in the github issue tracker). +Major releases should be kept to the minimum. \ No newline at end of file