Skip to content

Commit ade9e36

Browse files
committed
create contributing guidelines
1 parent 1128aa0 commit ade9e36

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#Contributing to Learning Resources repository by GDG Ahmedabad
2+
3+
We'd love for you to contribute to our source code and to make this initiative even better than it is
4+
today! Here are the guidelines we'd like you to follow:
5+
6+
- [Submission Guidelines](#submit)
7+
8+
## <a name="submit"></a> Submission Guidelines
9+
10+
### Submitting any links/books/tutorials or any resources
11+
Before you submit/suggest any resources please search the archive, maybe your resources is already included and available in the list. If the resource/links/materials you want to share is not in the list then you can commit and send a PR.
12+
13+
### Formatting guidelines
14+
We are following below formatting options for each commits:
15+
* H3 (i.e. ###) for the header
16+
* - (i.e. hyphen) for the list
17+
* []() for links. For example, [Learning resources repo](https://github.com/GDGAhmedabad/Learning-Resources/)
18+
19+
For formatting guidelines, check the guidelines given by Github [https://help.github.com/articles/basic-writing-and-formatting-syntax/](https://help.github.com/articles/basic-writing-and-formatting-syntax/)
20+
21+
For reference, you can check this page [https://github.com/GDGAhmedabad/Learning-Resources/blob/master/android/Useful_links.md](https://github.com/GDGAhmedabad/Learning-Resources/blob/master/android/Useful_links.md)
22+
23+
24+
25+
### Submitting a Pull Request
26+
Before you submit your pull request consider the following guidelines:
27+
28+
* Search [GitHub](https://github.com/GDGAhmedabad/Learning-Resources/pulls) for an open or closed Pull Request
29+
that relates to your submission. We don't want to duplicate effort!
30+
* Make your changes in a new git branch. Please be aware that we are following the [git flow branching model](http://nvie.com/posts/a-successful-git-branching-model/) with `master` as the branch for the next version!
31+
* Commit your changes using a descriptive commit message.
32+
33+
34+
35+

0 commit comments

Comments
 (0)