From 8921367919b2c900249c8ede40b95e3928f8019d Mon Sep 17 00:00:00 2001 From: Stephcraft Date: Sat, 2 Mar 2019 14:26:15 -0500 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..65c9d264 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 ``` for example: ```cd Desktop/Programming/Java``` +5. Execute ```git clone https://github.com//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`