Skip to content

Create CONTRIBUTING.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WOLFI3654 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create CONTRIBUTING.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 1. For the Repository
To start editing the repositories contents you have to click the fork button on the top right corner.

# 2. Clone the Repository
In order to fix a bug or add a feature you need to have a local copy of your forked repository.
Simply type 'git clone *your_repo_url* in your command line.

# 3. Fix the bug
After cloning the forked repository you are able to fix the bug or add a feature.
When you are done type 'git add .' and 'git commit -m"Fix bug XY / Add feature XY' followed by 'git push' to commit your changes.

# 4. Make a pullrequest
Lastly you can propose a pullrequest to the original repository. For that visit the forked repository on your github profile.
In the project headline you will be presented with a 'make pullrequest button'. Just click on it and follow the instructions on the screen.
You may want to add a comment to your pull request to make a detailed explanation of your changes.

# 5. You're done!
You have successfully made a pullrequest and supported an open source project

### If you have further questions consider visiting [This course on how to contribute to an open source project](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)