-
Notifications
You must be signed in to change notification settings - Fork 8
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
Showing
1 changed file
with
65 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,65 @@ | ||
|
||
# Contribution Rules📚: | ||
|
||
- You are allowed to make pull requests that break the rules. We just merge it ;) | ||
- Do NOT add any build steps e.g npm install (we want to keep this a simple static site) | ||
- Do NOT remove other content. | ||
- Styling/code can be pretty, ugly or stupid, big or small as long as it works | ||
- Try to keep pull requests small to minimize merge conflicts | ||
|
||
|
||
## Getting Started 🤩🤗: | ||
|
||
- Fork this repo (button on top) | ||
- Clone on your local machine | ||
|
||
```terminal | ||
git clone https://github.com/mongodbthailand/mongodbthailand.github.io.git | ||
``` | ||
- Navigate to project directory. | ||
```terminal | ||
cd Hacktoberfest2023 | ||
``` | ||
|
||
- Create a new Branch | ||
|
||
```markdown | ||
git checkout -b my-new-branch | ||
``` | ||
- Add your Name and your project | ||
```markdown | ||
git add . | ||
``` | ||
- Commit your changes. | ||
|
||
```markdown | ||
git commit -m "Relevant message" | ||
``` | ||
- Then push | ||
```markdown | ||
git push origin my-new-branch | ||
``` | ||
|
||
- Create a new pull request from your forked repository | ||
|
||
<br> | ||
|
||
## Avoid Conflicts {Syncing your fork} | ||
|
||
An easy way to avoid conflicts is to add an 'upstream' for your git repo, as other PR's may be merged while you're working on your branch/fork. | ||
|
||
```terminal | ||
git remote add upstream https://github.com/mongodbthailand/mongodbthailand.github.io | ||
``` | ||
|
||
You can verify that the new remote has been added by typing | ||
```terminal | ||
git remote -v | ||
``` | ||
|
||
To pull any new changes from your parent repo simply run | ||
```terminal | ||
git merge upstream/master | ||
``` | ||
|
||
This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent. |