-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from priyanshnama/contributing.md
CONTRIBUTING.md added
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Contributing | ||
|
||
## Getting Started | ||
|
||
1. Feel free to open an issue if you wish to propose something new. | ||
2. Fork the repository on GitHub. | ||
3. Clone the fork | ||
|
||
## Making Changes | ||
|
||
* Create a branch : `git checkout -b branch-name`. Please avoid working directly on the `master` branch. | ||
* Make commits of logical units. | ||
* Make changes in `repositories.json` file only. | ||
* Put this `json object` anywhere in between the other repositories listed in the file **but please do not add it at the start or end of the list.** | ||
|
||
|
||
```json | ||
{ | ||
"name": "repo-name", | ||
"link": "repo-link", | ||
"labels": ["issue-label1", "issue-label2"] | ||
}, | ||
``` | ||
* Make sure your commit messages are in the proper format. | ||
|
||
## Submitting Changes | ||
|
||
* Push your changes to the branch in your fork of the repository. | ||
* Submit a pull request to the repository. | ||
* The contributors look at Pull Requests and review them on a regular basis. | ||
* Upon merging of your pull request, `Readme.md` will be automatically updated listing the beginners-friendly repository added by you. |