From 0d5ec7e4632a0853ea10e16db70a3dc8dc0878db Mon Sep 17 00:00:00 2001 From: Johan Smits Date: Sun, 11 Mar 2018 10:50:17 +0100 Subject: [PATCH] Add templates for Github for creating new issues and contributing --- .github/CONTRIBUTING.md | 37 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 60 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 97 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..f931d5fa --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,37 @@ +## Pull requests + +We gladly accept pull requests to add documentation, fix bugs and, in some circumstances, +add new features to Spree. + +Here's a quick guide: + +1. Fork the repo + +2. Clone the fork to your local machine + +3. Create new branch then make changes and add tests for your changes. Only +refactoring and documentation changes require no new tests. If you are adding +functionality or fixing a bug, we need tests! + +4. Run the tests. `make build-no-cache generate-accounts run generate-accounts-after-run fixtures tests clean` + +5. Push to your fork and submit a pull request. If the changes will apply cleanly +to the master branch, you will only need to submit one pull request. + + Don't do pull requests against `-stable` branches. Always target the master branch. Any bugfixes we'll backport to those branches. + +At this point, you're waiting on us. We like to at least comment on, if not +accept, pull requests within several days days. +We may suggest some changes or improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted. + +Syntax: + +* Two spaces, no tabs. +* No trailing whitespace. Blank lines should not have any space. +* Follow the conventions you see used in the source already. +* Alphabetize the class methods to keep them organized + +And in case we didn't emphasize it enough: we love tests! + diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e062301c --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,60 @@ + + +## Context + + + +## Expected Behavior + + +## Actual Behavior + + +## Possible Fix + + +## Steps to Reproduce + + +1. +2. +3. +4. + +## Your Environment + +* Amount of RAM available: +* Mailserver version used: +* Docker version used: +* Environment settings relevant to the config: +* Any relevant stack traces ("Full trace" preferred): + + + + +