forked from androiddevnotes/awesome-android-kotlin-apps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CONTRIBUTING.md
25 lines (13 loc) · 1.68 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Contributing Guide
## How to contribute
- Fork the project from the `master` branch and submit a Pull Request (PR)
- Explain what the PR fixes or improves.
- If you want to add a new repo:
- Open the [input_data.json](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/input_data.json)
- Add repo url and tech stack there.
- If you want to add more content or modify the content in the [README](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.md) file, then modify the [README.model.md](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.model.md) file. DO NOT DIRECTLY MODIFY THE [README](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.md) file, the changes won't persist. Go to [README.model.md](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.model.md) file and then edit there. Your edits in the [README.model.md](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.model.md) will sync to [README](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.md) in few moments.
- For example, if you want to add new table to the [README](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.md), you open the [README.model.md](https://github.com/androiddevnotes/awesome-android-kotlin-apps/blob/master/README.model.md) file, and add there.
- Use sensible commit messages
- If your PR fixes a separate issue number, include it in the commit message.
- Use a sensible number of commit messages as well
- e.g. Your PR should not have 1000s of commits.