Skip to content

Commit

Permalink
Add an issue template and contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
matteblair committed May 6, 2017
1 parent 4602f63 commit aa7da0f
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 20 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing to Tangram ES

The easiest way to help out is to submit bug reports and feature requests on our [issues](https://github.com/tangrams/tangram-es/issues) page.

When submitting a bug report, please include:

- The device and operating system version that produced the bug
- The version or commit of Tangram ES that produced the bug
- Steps required to recreate the issue
- What happened
- What you expected to happen

Thanks!

## Building

If you'd like to contribute code to the project or just make changes for fun, you'll need to make sure your development environment is set up correctly.

- [Developing for Mac OS X](platforms/osx/README.md#setup)
- [Developing for Ubuntu Linux](platforms/linux/README.md#setup)
- [Developing for Android](platforms/android/README.md#setup)
- [Developing for iOS](platforms/ios/README.md#setup)
- [Developing for Raspberry Pi](platforms/rpi/README.md#setup)

## Development

The tangram-es project is divided into two parts: a portable C++14 [core library](core) and the various [platform interfaces](platforms).

To develop for the core library, it is usually easiest to build and test your changes using either the Mac OS X or Ubuntu desktop targets. These targets are the fastest and easiest to deploy and debug.

## Code Style

In general, code changes should follow the style of the surrounding code.

When in doubt, you can use the provided clang-format style file for automatic styling.

Install clang-format (available through brew or apt-get):
```
brew install clang-format
```
or
```
sudo apt-get install clang-format
```

Run clang-format with specified style (use -i to modify the contents of the specified file):
```
clang-format -i -style=file [file]
```
24 changes: 24 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
**TO REPRODUCE THE ISSUE, FOLLOW THESE STEPS:**

- List the steps you used
- To produce the result here
- Don't leave any out

**RESULT:**

Describe the result here.

**EXPECTED RESULT:**

Describe what you expected to see here.

**ENVIRONMENT:**

- What operating system and device did you produce this issue on?
- If you used a released version, what is the version number?

**OTHER:**

Any additional notes, comments, tips, tricks, gifs, suggestions, poetry, recipes, jokes

If you are able to record the log output from tangram-es, please attach it as a text file or share it using a site like https://hastebin.com/
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,3 @@ Currently we are targeting five platforms:
- [Mac OS X](platforms/osx)
- [Ubuntu Linux](platforms/linux)
- [Raspberry Pi](platforms/rpi)

## Code Style ##

In general, code changes should follow the style of the surrounding code.

When in doubt, you can use the provided clang-format style file for automatic styling.

Install clang-format (available through brew or apt-get):
```
brew install clang-format
```
or
```
sudo apt-get install clang-format
```

Run clang-format with specified style (use -i to modify the contents of the specified file):
```
clang-format -i -style=file [file]
```

0 comments on commit aa7da0f

Please sign in to comment.