Skip to content

Commit

Permalink
doc: Contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
Vicki Pfau committed Mar 23, 2018
1 parent d243a65 commit f00e8c8
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Issue summary

[Put a detailed description of the issue here.]

## System information

- [Operating system]
- [Python version]
- [Gym Retro version]
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Gym Retro Contribution Guidelines

At this time we are currently accepting the current forms of contributions:

- Bug reports in either the core functionality or game integrations
- Pull requests for core functionality bug fixes

Notably, we are not accepting these forms of contributions:

- New game integrations
- New features

This may change in the future.
In the meantime if you wish to integrate new games you are more than welcome to maintain unofficial repositories of additional games.

## Issue reports

Please include the following information in your issue reports:

- Operating system
- Python version
- Gym Retro version or git commit
- A detailed description of the issue

## Code contributions

Please try to adhere to the existing code style. There is a linter script included at `scripts/lint.sh`.

### Python

Gym Retro is written in a [PEP 8-compliant code style](https://www.python.org/dev/peps/pep-0008/) (minus the line length restriction). Please make sure to maintain this style in any contributions.

### C++

There is a `.clang-format` file that documents as best as possible the code style for Gym Retro. Please make sure to follow it.

0 comments on commit f00e8c8

Please sign in to comment.