Create CONTRIBUTING.md #12
Conversation
CONTRIBUTING.md
Outdated
| - Clone your forked repo locally. | ||
|
|
||
| ``` | ||
| $ git clone git@github.com:yourname/blog.git |
There was a problem hiding this comment.
Since we are suggesting SSH cloning, Might I suggest that you add a link to Setting up SSH in the git workflow?
There was a problem hiding this comment.
Oh, I wasn't aware this is SSH cloning. I just took the content from the main Mozilla India website's CONTRIBUTING.md as it is.
Should I replace the code with the one below?
$ git clone https://github.com/yourname/blog.gitLet's keep the setup simple for contributors.
There was a problem hiding this comment.
Hmm, Since it's Jekyll, I think most of the people will be developing with Linux; which till I know lacks a credential manager (I don't believe that caching the password can count as credential management) and thereby requiring people with 2FA to attach personal access token every time instead of the password. It would be better for people to clone with SSH.
Then again, I doubt beginners will be aware of such things and/or use 2FA. So keeping it HTTPS sounds like a possible way too. Not sure about why the Mozilla India contributing.md recommends using SSH, but I guess what I stated above might be the reason. So let's go with HTTPS for now. You can switch all the SSH commands to the HTTPS version.
There was a problem hiding this comment.
Yeah I myself am on linux (Ubuntu) and have never used SSH for cloning a git repo. I tried running git clone git@github.com:cseas/blog.git and got the following error:
Anyway, I've changed the SSH commands to HTTPS as suggested.
There was a problem hiding this comment.
That's cause you need to setup SSH xD, feel free to hit me up on twitter, etc. if you are interested in the same. Changes look good to me!
There was a problem hiding this comment.
I had to leave a comment here. Unless you want beginners to stay that way, what we need to show them is the way to grow. And not take shortcuts.
There was a problem hiding this comment.
That's true! Shortcuts are never the way to go, hence my initial recommendation of adding the link to Setting up SSH. I will switch it back to SSH along with a proper guide for it mentioned initially in the next week once my exams are done. Meanwhile, @cseas can give it a tackle if interested, feel free to resolve any doubts!
There was a problem hiding this comment.
Updated #5 with the discussion here. I might not be able to work on it at the moment.
|
I'm gonna merge without reviewing as we can always have further edits happening later. Thanks. |
Added contributing and setup guidelines as discussed in #5