kavin/LibreTube
1
0
Fork 0
mirror of https://github.com/libre-tube/LibreTube.git synced 2024-12-12 21:30:30 +05:30
Code Issues Projects Releases Wiki Activity

chore: improve contributing section in readme

Browse Source
This commit is contained in:
Bnyro 2023-08-12 09:04:28 +02:00 committed by GitHub
parent 3f016b9ced
commit 5d227081c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -105,11 +105,10 @@ Contributing
Whether you have ideas, translations, design changes, code cleaning or really heavy code changes, help is always welcome. The more is done, the better it gets! Please respect our [Code of Conduct](https://github.com/libre-tube/LibreTube/blob/master/CODE_OF_CONDUCT.md) in order to keep all interactions and dicussions healthy.
You can open and build the project like any other normal Android project by using Android Studio.
If creating a pull request containing code changes, please make sure to format your code with Android Studio before.
If creating a pull request containing code changes, please make sure to format your code with `ktlint --code-style=android-studio -F` before.
Please make sure the title of your pull request follows the [conventional commit types](https://github.com/commitizen/conventional-commit-types/blob/master/index.json) (e.g. `feat: support for xy`).
Please make sure the title of your pull request and the commit messages follow the [conventional commit types](https://github.com/commitizen/conventional-commit-types/blob/master/index.json) (e.g. `feat: support for xy`).
The most common commit types are "feat", "fix", "refactor", "ci" and "chore".
The commit messages however shouldn't contain any commit type, but only a short description of the change.
> **Note** <br>
> Any issue avoiding the issue template will be ignored and forced to be closed.