Skip to content

Commit e434651

Browse files
committed
corrected markdown in CONTRIBUTION.md
1 parent 9ef1e50 commit e434651

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

Diff for: CONTRIBUTION.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,44 @@
11
# DCN Contribution guide
2+
23
Whether you're new to GitHub and looking for experience or just want to help out, we welcome your contribution. This project is meant to give contributors an introduction into the world of code collaboration as well as basic web development.
34

45
If you haven't already, join the conversation in [our Discord server](https://discord.gg/acVJSXP). Let us know what you want to add to this project. If you need help with making a contribution, feel free to ask.
56

67
Thanks for showing interest to help grow Developers Circle Nepal.
78

89
## Forking and cloning
10+
911
In order to submit changes to the DCN repository, you'll need to fork the repository and maintain a local copy of it. Check out [GitHub's guide to forking](https://help.github.com/articles/fork-a-repo/) for info on how to do that.
1012

1113
If you followed the guide (replacing the example repo with DCN repo), you should have two copies of the DCN repository:
14+
1215
- one in your GitHub account (`github.com/YOUR-USERNAME/dev.circle.github.io`)
1316
- one local copy within a folder called `dev-circle-np.github.io`.
1417

1518
Your local repo's `upstream` should be set to `https://github.com/dev-circle-np/dev-circle-np.github.io.git`, like the example in [this section](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository) of the guide.
1619

1720
## Working with a local copy
21+
1822
**Note:** Make sure your master branch is synced to the original DCN repository and that you are working on a separate branch before you start making changes to your local repository. Here are the steps to follow:
1923

2024
1. Open Git Shell and navigate to the repository
2125
2. Make sure you are on the master branch, using `git status`:
2226

23-
```
27+
```python
2428
On branch master
2529
Your branch is up to date 'origin/master'
2630
```
27-
31+
2832
3. If you are not on master, use `git checkout master`
33+
2934
4. Do a `pull` with rebase against `upstream`:
3035
`git pull --rebase upstream master`
3136
This will sync your local repo with the original master without making an additional commit locally.
3237
5. Create a branch off of master with: `git checkout -B branchname` replacing `branchname` with the name of your new branch. Use a name that gives an idea of what feature or fix you are going to implement such as `navbar-styling`.
3338
6. Now you're ready to make some changes to your local files!
3439

3540
## Pushing changes to your GitHub fork
41+
3642
Alright, so you've made some changes in your local copy of the DCN repo, tested your changes on your browser and you're ready to submit those changes for all to see. Now what?
3743

3844
1. Run `git status` and you'll see all the files you've changed and haven't staged yet.
@@ -42,10 +48,11 @@ Alright, so you've made some changes in your local copy of the DCN repo, tested
4248
5. Push your commit to your fork on GitHub: `git push -u origin master`. The branch name should be the same as the branch you were working with.
4349

4450
## Submitting a pull request
51+
4552
Once you've got your changes pushed to your fork of the DCN repo on GitHub, it's time to [submit a pull request](https://help.github.com/articles/creating-a-pull-request/).
4653

4754
The name of your pull request (PR) should give us an idea of the changes you've made, such as `add styling to navbar`.
4855

4956
If your PR is meant fix a specific issue, add `closes #123` in the description of your PR where `#123` is the issue number. This will allow GitHub to automatically close the issue once your PR is merged
5057

51-
If your PR is not accepted, we'll let you know what changes need to be made.
58+
If your PR is not accepted, we'll let you know what changes need to be made.

0 commit comments

Comments
 (0)