Skip to content

Commit 1cd6a65

Browse files
authored
Merge pull request #15 from hacktober17/anurag-contributing
Update CONTRIBUTING.md
2 parents 5bf916d + 64f5869 commit 1cd6a65

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,72 @@
11

2+
# HacktoberFest'17
3+
4+
Anyone can use this project to make their contribution to an open source project on GitHub.
5+
6+
Celebrate [HacktoberFest](https://hacktoberfest.digitalocean.com/) by getting involved in the Open Source Community by completing some simple tasks in this project.
7+
8+
This is a Public Repository open to all members of the GitHub Community. Any member of the community may contribute to this project without being a collaborator.
9+
10+
11+
## What is Hacktoberfest?
12+
A month-long celebration from October 1st - 31st sponsored by [Digital Ocean](https://hacktoberfest.digitalocean.com/) and [GitHub](https://github.com/blog/2433-celebrate-open-source-this-october-with-hacktoberfest) to get people involved in [Open Source](https://github.com/open-source). Create your very first Pull Request to any Public Repository on GitHub and contribute to the Open Source Developer Community.
13+
14+
[https://hacktoberfest.digitalocean.com/](https://hacktoberfest.digitalocean.com/)
15+
16+
17+
## How Contribute to This Project
18+
Here are 3 quick and painless ways to contribute to this project:
19+
20+
* Add a program in any language. (A simple Hello World would be suffice.)
21+
To do so, first create a issue with the task you are doing. For Ex. Issue - creating bubble sort in C. Add the HacktoberFest label in the issue and assign the issue to yourself. Create a pull request in response to that issue and finally submit it for review.
22+
23+
* How to name your branch?
24+
username_hello_world_in_c
25+
26+
Also create a directory for any new programs if it doesn't exist.
27+
ex. hello_world, bubble_sort.
28+
Inside these directories you can create your own file with program_name.language_extension (hello_world.cpp)
29+
30+
Finally, wait for it to be merged!
31+
32+
## Getting Started
33+
* Fork this repository (Click the Fork button in the top right of this page, click your Profile Image)
34+
* Clone your fork down to your local machine
35+
```markdown
36+
git clone https://github.com/your-username/programming.git
37+
```
38+
* Create a branch
39+
```markdown
40+
git checkout -b branch-name
41+
```
42+
* Make your changes (Choose from any task below)
43+
* Commit and Push
44+
```markdown
45+
git add .
46+
git commit -m 'commit message'
47+
git push origin branch-name
48+
```
49+
* Create a New Pull Request from your forked repository (Click the New Pull Request button located at the top of your repo)
50+
* Wait for your PR review and merge approval!
51+
* __Star this repository__ if you had fun!
52+
53+
54+
55+
Don't forget to include the comments as seen above. Feel free to include additional information about the lanuage you chose in your comments too! Like a link to a helpful introduction or tutorial.
56+
57+
## Reference Links
58+
Here is a great tutorial for creating your first Pull Request by [Roshan Jossey](https://github.com/Roshanjossey)
59+
[https://github.com/Roshanjossey/first-contributions](https://github.com/Roshanjossey/first-contributions)
60+
61+
Managing your Forked Repo [https://help.github.com/articles/fork-a-repo/](https://help.github.com/articles/fork-a-repo/)
62+
63+
Syncing a Fork [https://help.github.com/articles/syncing-a-fork/](https://help.github.com/articles/syncing-a-fork/)
64+
65+
Keep Your Fork Synced [https://gist.github.com/CristinaSolana/1885435](https://gist.github.com/CristinaSolana/1885435)
66+
67+
Checkout this list for README examples - Awesome README [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
68+
69+
Github-Flavored Markdown [https://guides.github.com/features/mastering-markdown/](https://guides.github.com/features/mastering-markdown/)
70+
71+
## Additional References Added By Contributors
72+
GitHub license explained [https://choosealicense.com](https://choosealicense.com)

0 commit comments

Comments
 (0)