From a381a40cb2421807b4a3a1390983e49d649f10ee Mon Sep 17 00:00:00 2001 From: Jelmer Snoeck Date: Mon, 8 Aug 2016 17:17:03 +0100 Subject: [PATCH] Contributing: add guidelines. --- .github/ISSUE_TEMPLATE.md | 19 +++++++++++++++++++ CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 23 +++++++++++++++++++++++ 3 files changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..c39bf60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ +# This is to discuss a [bug|feature|question] + +In case of a bug: + +## What version are you using? + +## What are the steps to reproduce the issue? + +## What is the expected behaviour? + +## What is the actual behaviour? + +In case of a feature: + +## Describe the feature + +In case of a question: + +## Write down your question, possibly with an example diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2902336 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Changelog + +## v1.0.0 - 2016-08-08 +First official release. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e4300d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to Experiment + +## Did you find a bug? + +When [reporting bugs](https://github.com/jelmersnoeck/experiment/issues/new), try to be as thorough as possible: +- What version are you using? +- What are the steps to reproduce the issue? +- What is the expected behaviour? +- What is the actual behaviour? + +When creating a new issue, a template will be injected where you can choose +wether it is a bug report, a feature request or a question. + +## Did you write a patch? + +Bug fixes and code improvements are always welcome (thanks for taking the time!). + +New features are welcome as well, but they will be evaluated per case. A general +rule is to not generate external dependencies. If you'd rather not risk spending +time on a patch to possibly see it turned down later on, please start a +discussion by opening a [new issue](https://github.com/jelmersnoeck/experiment/issues/new) where you state this is a feature request. + +Don't forget to add your changes to the [changelog](CHANGELOG.md).