forked from acekyd/made-in-nigeria
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.md
36 lines (18 loc) · 1.67 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
26
27
28
29
30
31
32
33
34
35
# Made in Nigeria Github collection Guidelines
## Contributing a Project
To add a new project to the collection, please ensure they meet the following requirements arranged in order of importance
* The project must be **made in Nigeria** as the name implies :grin:.
* The project must be open source.
* The project must have global use - meaning it's not made just for use by Nigerians and there really is no geographical limitation for anyone that may be interested in using this project.
* The project should have at least 10 stars. This is to serve as a way to determine that people actually have a use for the project and it does what it says it does. [ Stars likely to go up as time goes on :smiley: ].
* The project should not be a list of some sort.
* Ensure to provide a social media url of the creator of the project outside GitHub.
* Try to add the project to it's appropriate alphabetical location.
* You might want to include the **made in Nigeria** badge to your project. Place the following code in your **README** file:
`[](https://github.com/acekyd/made-in-nigeria)`
More requirements may be added as time goes on.
## Contributing to Repo showcase website
There is a webpage that has been developed by awesome members of the community used to view the contents of this repo in a very pleasing manner. If you'd like to contribute to this website, please try to follow these steps:
* If you are fixing a bug or adding a new feature, please create a branch for it.
* Make Pull requests as descriptive as possible.
* Every other best practice recommended when contributing to a project.