Skip to content

Commit 147dede

Browse files
committed
Add guidelines for adding apps
+ fix mdl issues
1 parent 2613be6 commit 147dede

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
# Contribution Guidelines
2+
23
> The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away. Please make sure you checked every box in the PR template.
34
45
## Before adding something to the list
6+
57
1. Make sure you are editing README.md only, no other files are allowed to be edited.
68
2. Add your item to the category it belongs to. Try to avoid creating completely new categories.
79
3. Make sure your item is added to the bottom of the items listed in a category, don't add it in at the middle.
810
4. Don't submit dead links and try to always submit HTTPS links.
911
5. Make sure you're linking to an English resource, other languages not allowed *at this moment*
1012
6. If there is only support for some devices please mention that by using the [badges](/media/badges) provided.
1113
7. Add something that is truly awesome and stands out. A project that shows how to monitor a greenhouse, water a plant or trigger LEDs are already out there on the web. This is not the place for those.
14+
8. If you are adding to the [Applications](https://github.com/thibmaek/awesome-raspberry-pi#useful-apps) please do it in the format of
15+
16+
```markdown
17+
**App name** - Description goes here. [Android](https://play.google.com/...), [iOS](https://itunes.apple.com/...)
18+
```
1219

1320
### Adding an item to the list
21+
1422
1. Click README.md
1523
2. Click the *pencil button* in the upper right corner next to raw | blame | history
1624
3. Github will automatically create a fork for this repo on your account.
@@ -22,6 +30,7 @@
2230
Submitted PRs will be checked as soon as possible. If something is incorrect it will be labeled `awaiting-user` with the problem stated in the PR comments. If a PR becomes stale or no action is taken after some time with the PR being labeled `awaiting-user`, this PR will get the `reply-timeout` label and will be closed.
2331

2432
#### Gitmoji
33+
2534
It's recommended that you use [gitmoji](https://gitmoji.carloscuesta.me/) when contributing. The supported gitmoji must proceed the commit message followed by a space and be one of:
2635

2736
|Name, Use|Emoji|Example

0 commit comments

Comments
 (0)