Skip to content

Commit

Permalink
Readme edit
Browse files Browse the repository at this point in the history
  • Loading branch information
AYAN committed Jan 4, 2021
1 parent 31b301c commit 53f6383
Showing 1 changed file with 77 additions and 0 deletions.
77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,83 @@ We are using ```GoDot``` game engine for the development purpose of the game.To
* Git. [See steps](https://www.atlassian.com/git/tutorials/install-git)
* ```GoDot``` for your operating System (Linux/MAC OS/Windows).[See the installation steps](https://godotengine.org/download/)

## Getting Started

[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/tetra-devs/maingame?logo=github)](https://vinitshahdeo.github.io/Water-Monitoring-System/) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/tetra-devs/maingame?color=bluevoilet&logo=github)](https://github.com/tetra-devs/maingame/commits/) [![GitHub repo size](https://img.shields.io/github/repo-size/tetra-devs/maingame?logo=github)](https://vinitshahdeo.github.io/Water-Monitoring-System/)

**1.** Fork [this](https://github.com/tetra-devs/maingame/) repository.
Click on the <a href="https://github.com/tetra-devs/maingame/"><img src="https://img.icons8.com/ios/24/000000/code-fork.png"></a> symbol at the top right corner.

**2.** Clone the forked repository.

```bash
git clone https://github.com/<your-github-username>/maingame
```

**3.** Navigate to the project directory.

```bash
cd Water-Monitoring-System
```

**4.** Create a new branch.

```bash
git checkout -b <your_branch_name>
```

**5.** Make changes in source code.

**6.** Stage your changes and commit

```bash
#Add changes to Index
git add .

#Commit to the local repo
git commit -m "<your_commit_message>"
```

>CAUTION: Synch up your local repo with [original repo](https://github.com/tetra-devs/maingame) (Upstream) before pushing your commits.
>This avoids unnecessary conflicts during the merge.
>NOTE: You can do so by adding a [remote handler](https://www.atlassian.com/de/git/tutorials/syncing) reference to the original repo and pull the changes from the respective branch.
>Resolve the [merge-conflicts](https://www.atlassian.com/de/git/tutorials/using-branches/merge-conflicts) if any.

>```bash
>#Add upstream repo
>git remote add upstream https://github.com/tetra-devs/maingame.git
>
>#Disable accidental push to the upstream
>git remote set-url --push upstream DISABLE
>
>#List the remote repo and fetch references
>git remote -v && git fetch upstream
>
>#Check for any new commits in the upstream branch
>git log HEAD..upstream/master #No output indicates, upstream has not moved ahead
>
>#See the patch difference between local and upstream branch
>git diff -p HEAD..upstream/master
>
>```
>CAUTION: If the upstream has moved ahead, rebase your commit and resolve conflicts if any. [Skip otherwise]
>```bash
>git rebase upstream/master
>```
>
**7.** Push your local commits to the remote repo.
```bash
git push -u origin <your_branch_name>
```
**8.** Create a [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) !
**9.** **Congratulations!** Sit and relax, you've made your contribution to our project
### Repository Structure
Expand Down

0 comments on commit 53f6383

Please sign in to comment.