Skip to content

Commit

Permalink
[ci skip] added github issue templates and contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
martibosch committed Jul 10, 2019
1 parent 165561e commit 6071022
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Please don't file issues directly, use one of our available templates:

Bugs: https://github.com/martibosch/pylandstats/issues/new?template=bug.md
Feature Requests: https://github.com/martibosch/pylandstats/issues/new?template=feature.md

Thank you.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATES/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
* PyLandStats version:
* Python version:
* Operating System:

### Description

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.

### What I Did

```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
```
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATES/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Description

Describe your feature request
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

Contributions are always greatly appreciated and credit will always be given.

## Types of contributions

### Report bugs

Report bugs at https://github.com/martibosch/pylandstats/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

### Fix bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

### Implement features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

## Pull request guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
3. The pull request should work for Python 2.7 and 3.6, as well as for PyPy. Check https://travis-ci.org/martibosch/pylandstats/pull_requests and make sure that the tests pass for all supported Python versions.

0 comments on commit 6071022

Please sign in to comment.