Skip to content

Commit

Permalink
Adds contributing, issue template, and pull request template (#51)
Browse files Browse the repository at this point in the history
* Adds contributing, issue template, and pull request template

* Update CONTRIBUTING.md

* Adds link to code style repo
  • Loading branch information
ecgreb authored and sarahsnow1 committed Nov 4, 2016
1 parent f459ef1 commit e5cda24
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/CONTRIBUTING.md
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.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Description

### Steps to Reproduce

### Pelias & Android Version
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Overview

### Proposed Changes

0 comments on commit e5cda24

Please sign in to comment.