-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
158c7bc
commit 8921367
Showing
1 changed file
with
29 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,29 @@ | ||
# Contribute | ||
|
||
#### Setup | ||
1. Download git [here](https://git-scm.com/downloads) | ||
2. Fork this repository. Press on the Fork button at the top right corner. This will clone it to your GitHub account. | ||
3. Open CMD/command prompt if on Windows or Terminal if on mac | ||
4. Now, let's clone your fork. In command prompt, type ```cd <directory/to/where/you/want/your/project>``` for example: ```cd Desktop/Programming/Java``` | ||
5. Execute ```git clone https://github.com/<your-github-username>/Project-16x16/``` example url: ```https://github.com/Noodleman123/Project-16x16/``` | ||
6. Execute ```cd Project-16x16``` to go in the project directory | ||
7. Execute ```git checkout development``` to have the right files, the ones that are being developed. | ||
|
||
#### Save on your local version control aka git | ||
You should execute these 2 commands everytime you complete a task or something important: | ||
``` | ||
git add . | ||
git commit -m "description telling what you modified/added" | ||
``` | ||
|
||
#### Save in the cloud aka GitHub | ||
You should save your local work on your forked GitHub when you accomplish something important. | ||
``` | ||
git push development | ||
``` | ||
|
||
#### Pull request | ||
A pull request is the final step to contribute something. A request should be made when you complete a "milestone" or resolve an issue. | ||
1. Go to the project 16x16 GitHub repository and click on Pull requests | ||
2. Click on the big green Pull request button | ||
3. Be sure to choose the right repository and the correct branch which is `development` |