From 75e8ef08ecc2797be8f28cebe33017e9962a203e Mon Sep 17 00:00:00 2001 From: Tom Hutchison Date: Fri, 28 Apr 2017 16:39:52 -0400 Subject: [PATCH] Project management --- .github/CONTRIBUTING.md | 25 +++++++++++++++++++ .../ISSUE_TEMPLATE.md | 0 .github/PULL_REQUEST_TEMPLATE.md | 9 +++++++ 3 files changed, 34 insertions(+) create mode 100644 .github/CONTRIBUTING.md rename ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE.md (100%) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..df0f782 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to Pivot + +Pivot is released using [Semantic Versioning 2.0.0](http://semver.org/). Please read about how Semantic Versioning is used for software releases, understand what a breaking change is and backwards compatibility. + +## Bug fixes + +All bug fixes should PR against the branch of the version of Pivot with the bug. If you want to fix a bug, please do the following: + +1. Open an issue in [Issues](https://github.com/Hutchy68/pivot/issues) and make sure you tag it with a `bug` tag. If the bug already is a known issue, skip this step. +2. Create a branch in your repo with the name of the `bug` or whatever you feel comfortable with(patch-1, bugX, etc.) using the Pivot's `master` branch as a base. +3. If it will take time to fix, periodically check and pull down updates to Pivot's `master` branch as you are working on the bug fix. Commits can and will occur to `master` which may affect your `bug fix` branch. +4. When you are ready to issue a PR against the `master` branch of Pivot, please use `[bug]` as a tag at the beginning of the PR's title. +5. Please reference the issue# in the PR's description and include any information for testing the bug fix. + +## Development of New Feature + +All new features for Pivot should PR against the `master` branch. If you want to add a new feature, you should do the following: + +1. Open an issue in [Issues](https://github.com/hutchy68/pivot/issues) and make sure you tag it with the `feature` tag. +2. Create a branch in your repo with the name of the `feature` or whatever you feel comfortable with using Pivot's `master` branch as a base. +3. Periodically check and pull down updates to Pivot's `master` branch as you are working on your proposed feature. Commits can and will occur to `master` which may affect your `feature` branch. +4. When you are ready to issue a PR against the `master` branch of Pivot, please use `[feature]` as a tag at the beginning of the PR's title. +5. Please reference the issue# in the PR's description and include any information for testing the feature. + + diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c02c1d5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +### PR Submission: + +All PR's welcome, even those without an Issue + +* [ ] Have tested this PR and it adds a feature or fixes and issue noted below. + +### Additional Information Below + +