Skip to content

Commit

Permalink
updated contributing indications
Browse files Browse the repository at this point in the history
  • Loading branch information
gotev committed Nov 1, 2019
1 parent d19ade9 commit 2bc30e4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@

Contributions are welcome and encouraged! Just fork the project and then send a pull request. Be ready to discuss your code and design decisions.

#### Code Style
Android Upload Service enforces Kotlin standard coding style, using [ktlint](https://ktlint.github.io/).

To speed up development, it's highly recommended to install ktlint and to execute the following in `android-upload-service` root directory:

```
ktlint installGitPreCommitHook
cd examples/app/ && ktlint --android applyToIDEAProject -y && cd ../..
```

#### Development
To develop Android Upload Service and its core modules, clone the project, then open `examples/app/build.gradle` from your Android Studio. In this way you can see all the modules and the demo app, make changes and deploy to your emulator or real device for testing.

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

### <a name="help"></a> Asking for help and bug reports
Expand Down
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,7 @@ Apps and libraries powered by this library. To be included in the following list
- [Samajbook](https://play.google.com/store/apps/details?id=com.marothiatechs.samaj)
- [Codeaty](https://play.google.com/store/apps/details?id=com.saifraheem.BagoLearn)

## Contributing <a name="contribute"></a>
* Do you have a new feature in mind?
* Do you know how to improve existing docs or code?
* Have you found a bug?

Contributions are welcome and encouraged! Just fork the project and then send a pull request. Be ready to discuss your code and design decisions.
## [Contributing](CONTRIBUTING.md) <a name="contribute"></a>

## Do you like the project? <a name="donate"></a>
Put a star, spread the word and be part of it! New ideas, bugfixes and PRs are always welcome!
Expand Down

0 comments on commit 2bc30e4

Please sign in to comment.