Skip to content

Commit aa7da0f

Browse files
committed
Add an issue template and contributor guide
1 parent 4602f63 commit aa7da0f

File tree

3 files changed

+73
-20
lines changed

3 files changed

+73
-20
lines changed

CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to Tangram ES
2+
3+
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.
4+
5+
When submitting a bug report, please include:
6+
7+
- The device and operating system version that produced the bug
8+
- The version or commit of Tangram ES that produced the bug
9+
- Steps required to recreate the issue
10+
- What happened
11+
- What you expected to happen
12+
13+
Thanks!
14+
15+
## Building
16+
17+
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.
18+
19+
- [Developing for Mac OS X](platforms/osx/README.md#setup)
20+
- [Developing for Ubuntu Linux](platforms/linux/README.md#setup)
21+
- [Developing for Android](platforms/android/README.md#setup)
22+
- [Developing for iOS](platforms/ios/README.md#setup)
23+
- [Developing for Raspberry Pi](platforms/rpi/README.md#setup)
24+
25+
## Development
26+
27+
The tangram-es project is divided into two parts: a portable C++14 [core library](core) and the various [platform interfaces](platforms).
28+
29+
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.
30+
31+
## Code Style
32+
33+
In general, code changes should follow the style of the surrounding code.
34+
35+
When in doubt, you can use the provided clang-format style file for automatic styling.
36+
37+
Install clang-format (available through brew or apt-get):
38+
```
39+
brew install clang-format
40+
```
41+
or
42+
```
43+
sudo apt-get install clang-format
44+
```
45+
46+
Run clang-format with specified style (use -i to modify the contents of the specified file):
47+
```
48+
clang-format -i -style=file [file]
49+
```

ISSUE_TEMPLATE.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**TO REPRODUCE THE ISSUE, FOLLOW THESE STEPS:**
2+
3+
- List the steps you used
4+
- To produce the result here
5+
- Don't leave any out
6+
7+
**RESULT:**
8+
9+
Describe the result here.
10+
11+
**EXPECTED RESULT:**
12+
13+
Describe what you expected to see here.
14+
15+
**ENVIRONMENT:**
16+
17+
- What operating system and device did you produce this issue on?
18+
- If you used a released version, what is the version number?
19+
20+
**OTHER:**
21+
22+
Any additional notes, comments, tips, tricks, gifs, suggestions, poetry, recipes, jokes
23+
24+
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/

README.md

-20
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,3 @@ Currently we are targeting five platforms:
2525
- [Mac OS X](platforms/osx)
2626
- [Ubuntu Linux](platforms/linux)
2727
- [Raspberry Pi](platforms/rpi)
28-
29-
## Code Style ##
30-
31-
In general, code changes should follow the style of the surrounding code.
32-
33-
When in doubt, you can use the provided clang-format style file for automatic styling.
34-
35-
Install clang-format (available through brew or apt-get):
36-
```
37-
brew install clang-format
38-
```
39-
or
40-
```
41-
sudo apt-get install clang-format
42-
```
43-
44-
Run clang-format with specified style (use -i to modify the contents of the specified file):
45-
```
46-
clang-format -i -style=file [file]
47-
```

0 commit comments

Comments
 (0)