-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from jelmersnoeck/jelmer/contributing-guidelines
Contributing: add guidelines.
- Loading branch information
Showing
3 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Changelog | ||
|
||
## v1.0.0 - 2016-08-08 | ||
First official release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |