-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds contributing, issue template, and pull request template (#51)
* Adds contributing, issue template, and pull request template * Update CONTRIBUTING.md * Adds link to code style repo
- Loading branch information
1 parent
f459ef1
commit e5cda24
Showing
3 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Contributing to Pelias for Android | ||
|
||
Contributor guidelines for the Pelias Android SDK. | ||
|
||
## Getting Started | ||
|
||
Fork and clone the repo: | ||
|
||
git clone [email protected]:username/pelias-android-sdk.git | ||
|
||
Create a feature branch to make your changes: | ||
|
||
git checkout -b my-feature-name | ||
|
||
## Writing Tests | ||
|
||
Good test coverage is an important guard against defects and regressions in the Pelias for Android library. All classes should have unit test classes. All public methods should have unit tests. Those classes and methods should have all their possible states well tested. Pull requests without tests will be sent back to the submitter. | ||
|
||
## Building and Testing | ||
|
||
Before submitting a pull request you can build the library and run all tests and code quality checks locally using: | ||
|
||
./gradlew clean assembleDebug checkstyle copyTask testDebug install | ||
|
||
## Code Style | ||
|
||
Essentially the IntelliJ default Java style, but with two-space indents. | ||
|
||
1. Spaces, not tabs. | ||
2. Two space indent. | ||
3. Curly braces for everything: if, else, etc. | ||
4. One line of white space between methods. | ||
5. Single imports only. | ||
|
||
The full Mapzen Android code style settings can be installed from https://github.com/mapzen/java-code-styles. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
### Description | ||
|
||
### Steps to Reproduce | ||
|
||
### Pelias & Android Version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
### Overview | ||
|
||
### Proposed Changes |