Docs update #105
Docs update #105
Conversation
|
Deploy preview ready! Built with commit 01d3e02 |
|
I think it would be good if there is also an index of topics at the beginning. |
|
I was thinking to raise a beginner friendly issue for that |
|
OK cool |
There was a problem hiding this comment.
@M-ZubairAhmed Thanks for taking time to write these.
Can we add how to fix this error also to Appendix.
CONTRIBUTING.md
Outdated
|
|
||
| 1. Find an issue that needs assistance by searching for the [Help Wanted](https://github.com/coderplex/coderplex/labels/help-wanted) tag. | ||
| - [Coderplex](https://github.com/coderplex/coderplex) * : Frontend of the application |
There was a problem hiding this comment.
Check this line once we have * by mistake I think
CONTRIBUTING.md
Outdated
| <br/> | ||
| Familiarity with git is mandatory. | ||
|
|
||
| ### Running |
There was a problem hiding this comment.
I think this should be labeled as
Running Locally
And I feel it should go under Sending a Pull Request section
|
what was the fix for that error? |
|
That error occurs when user has local fork of our repo and later pull changes from our repo and changes have new packages added to
|
CONTRIBUTING.md
Outdated
| 6. Add and commit your code. Please give meaning full commit messages. | ||
| 7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork. | ||
| 8. Push the code to your fork. | ||
| 9. Raise the pull request from your created branch to `master` branch of coderplex. |
There was a problem hiding this comment.
shoud we change this to develop. and explain a little about out branching system?
There was a problem hiding this comment.
Yes we will be changing default branch as devlop (I made typo while creating this will modify soon to develop). So update master to develop in guide and mention why we are doing so.
|
@M-ZubairAhmed What is the status of this PR? |
CONTRIBUTING.md
Outdated
| $ yarn lint | ||
| ``` | ||
| 6. Add and commit your code. Please give meaning full commit messages. | ||
| 7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork. |
There was a problem hiding this comment.
Pull latest code from upstream repository's
master,
Here its develop I think?
|
lets review and merge this. later changes can be opened by issues |
* little bit on nvm * added nvm instructions, new issues docs * completed contributing * error added and indent spaces * index fix * branching system added * sectios rearranged * start removed * removed extra section of branching model * fix of #105 (review)
#102 Open for review and more editing to Contributing.md