Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing: add guidelines. #9

Merged
merged 1 commit into from
Aug 8, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Changelog

## v1.0.0 - 2016-08-08
First official release.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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).