From 757142a1cc59530eafee3f8a4d441183b253570e Mon Sep 17 00:00:00 2001 From: BRIAN MUENZENMEYER Date: Fri, 19 Feb 2016 00:42:27 -0600 Subject: [PATCH] added .github dir and templates --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 14 +++++++------- .github/ISSUE_TEMPLATE.md | 9 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 3 files changed, 21 insertions(+), 7 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (52%) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 52% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 87af6849d..7edd1a3d0 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,12 +1,12 @@ -#Contributing to Patternlab - Node -If you'd like to contribute to patternlab - node, please do so! There is always a lot of ground to cover, with patternlab - php being so feature-rich. +# Contributing to Patternlab Node +If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse. -No pull request is too small. Check out any [up for grabs issues](https://github.com/pattern-lab/patternlab-node/labels/up%20for%20grabs) as a good way to get your feet wet. +No pull request is too small. Check out any [up for grabs issues](https://github.com/pattern-lab/patternlab-node/labels/up%20for%20grabs) as a good way to get your feet wet, or add some more unit tests. -##Guidelines -1. Please keep your pull requests concise and limited to **ONE** substantive change at a time. -2. _ALWAYS_ submit pull requests against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request. -3. If you can, add some unit tests using the existing patterns +## Guidelines +1. Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier. +2. _ALWAYS_ submit pull requests against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request. If you have a major feature to stabilize over time, talk to @bmuenzenmeyer about making a dedicated `feature-branch` +3. If you can, add some unit tests using the existing patterns in the `./test` directory ##Coding style Regarding code style like indentation and whitespace, follow the conventions you see used in the source already. Add enough source code comments to help the next person. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..21e29ed60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ +I am using Pattern Lab Node `vX.X.X` on `Windows|Mac|Linux`, using the `grunt|gulp` configuration. + +##### Expected Behavior + + +##### Actual Behavior + + +##### Steps to Reproduce diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..bbe1ddf1f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +**Target the `dev` branch!** + +Addresses # + +Summary of changes: