Skip to content

Commit

Permalink
Update contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
adriangl committed Aug 19, 2020
1 parent 5799474 commit a52a7f4
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ The steps to request enhancements are pretty similar to the ones used when repor
If you feel that you can contribute to the project with bug fixes or new enhancements by coding them yourself, that's great!! (In fact we encourage you to do it :grin:!)
Don't forget to follow these steps to have your contribution considered by the maintainers of the project:

* Fork the project and create a new branch in your fork with the new code
* Ensure that the code you write solves the issue you picked and that it follows the [style guide](#Style-guide)
* After you've checked that the code is good to go, submit a PR so we can take a look at it!
* Fork the project and create a new branch in your fork with the new code.
* Ensure that the code you write solves the issue you picked and that it follows the [style guide](#Style-guide).
* After you've checked that the code is good to go, submit a PR to the `develop` branch so we can take a look at it!

### Adding translations
If you want to translate the project to your native language, you can do it too!
Expand All @@ -37,11 +37,14 @@ The steps are pretty simple:
* We use [PoEditor][poeditor-page] to manage translations, so first create an account there.
* Join the project with [this link][poeditor-join-link].
* Choose if you want to complete translations for unfinished languages or if you want to translate the project to a new language.
* After you create the translations, create a new PR with the new translation.
* Fork the project.
* Add your PoEditor `apiToken` to `/poeditor.properties`.
* Create a new branch for the translations and run this command in console in the root of the project: `./gradlew importPoEditorStrings`.
* Create a PR with the new synced translations.
* Don't forget to follow the placeholder syntax defined in the [PoEditor plugin that the app uses][poeditor-plugin-placeholders].
* After creating or updating the translations in PoEditor, you can:
* Create an issue to notify about new translations so the maintainers can sync them to the main branch
* Create a PR with the new translations
* Fork the project.
* Add your PoEditor `apiToken` to `/poeditor.properties`.
* Create a new branch for the translations and run this command in console in the root of the project: `./gradlew importPoEditorStrings`.
* Create a PR with the new synced translations.

## Style guide
### Git commit messages
Expand All @@ -51,11 +54,12 @@ The steps are pretty simple:

### Kotlin style guide
* A project style for IntelliJ/Android Studio users is embedded in the project, so ensure that the code you develop follows it.
* Install the git hooks that the project provides via `./gradlew installGitHooks` so message and code hooks can be run.
* Install the git hooks that the project provides via `./gradlew installGitHooks` so commit messages and code hooks can be run.
* Detekt will be run whenever you push changes to the repository. That way you don't need to remember to constantly check it whenever you change stuff in the code!
* No hungarian notation!

[search-bug-reports]:https://github.com/adriangl/pict2cam/labels/bug
[search-enhancements]:https://github.com/adriangl/pict2cam/labels/enhancement
[poeditor-page]:https://www.poeditor.com
[poeditor-join-link]:https://poeditor.com/join/project/yGKahGPrHb
[poeditor-join-link]:https://poeditor.com/join/project/yGKahGPrHb
[poeditor-plugin-placeholders]:https://github.com/bq/poeditor-android-gradle-plugin#handling-placeholders

0 comments on commit a52a7f4

Please sign in to comment.