Add Contributing guideline #555
Conversation
|
Could you split this PR in 3? :) |
spacewander
force-pushed
the
contributing
branch
from
c81110e to
3de4817
Compare
|
Done |
| @@ -0,0 +1,16 @@ | |||
| ## Your new git-extra command should support... | |||
There was a problem hiding this comment.
## Your new git-extra command should support
|
Thanks. Great work! I have added my two cents. |
|
At the bottom we could add something like: You are welcome to open up an issue to discuss new commands or features before opening a pull request. |
| ## Your new git-extra command should support... | ||
|
|
||
| * Should support Mac and Linux(You may need to browse their man page) | ||
| * Should support Bash 3 or newer(If you are not sure, [Bash versions](http://tldp.org/LDP/abs/html/bash2.html)) |
There was a problem hiding this comment.
I don't actually think we will have much difficulties supporting Bash 3.0 (at least that's the impression I got from scanning over the changelogs), but it may be difficult for people to test it. I tried building Bash 3.0 on OSX, and I was unable to, even with all the patches.
Now, the default shell on my OSX El Capitan is 3.2 so that one shouldn't be hard to get hold of.
Should we say Bash >= 3.2?
|
What about the latest version of CONTRIBUTING.md? |
| @@ -0,0 +1,18 @@ | |||
| ## Your new git-extra command should support | |||
|
|
|||
| * OSX, Ubuntu, FreeBsd(You may need to browse their man page) | |||
There was a problem hiding this comment.
Perhaps OS X, Ubuntu, and FreeBSD (you may need to check the documentation for compatibility issues)*?
We could also add a note at the bottom (hence the *) saying something along the lines of "if you aren't able to test your new command on a platform, make that clear in your PR and someone else may be able to test it on their system"
There was a problem hiding this comment.
I'm in favor of both of those suggestions.
|
LGTM, @spacewander! I just mainly made a couple formatting changes along with one suggestion regarding what to do if you are unable to test the command on a particular OS. On the topic of which OS's to support, should we explicitly include CentOS/RHEL as a requirement? Or would that be covered by Ubuntu already? |
|
@qw3rtman |
|
I'm good with that. So let's replace @nicolaiskogheim, what do you think? |
|
OSX, Linux, BSD is fine by me 👍 |
|
Let's just hold this until #557 is in. |
|
#557 is in, this is good to merge. |
@hemanth @qw3rtman @nicolaiskogheim
Let's have a look at this fresh guideline!