Update CONTRIBUTING file to match current practices. #362
Conversation
| ``` | ||
| Take a look to make sure things are as expected, then... | ||
| ``` | ||
| git push |
There was a problem hiding this comment.
Does this actually work? Maybe I have some different config, but just git push pushes only the current branch to its upstream. What I have to do is something like this git push origin master 2.0-devel 2.1-devel 3.0-devel.
There was a problem hiding this comment.
That is an example of merging 2.0-devel to 2.1-devel. Maybe I should make that more clear.
|
Apart from the above question I'd like to ask why this document uses the markdown syntax while we use the ReST syntax everywhere else (AFAICT). |
|
I used markdown because I forgot that github will render the ReST nicely as well when people click the link when creating a pull request. I'll convert it. |
dwlehman
force-pushed
the
contributing-update
branch
from
d15b85c
to
16ca008
Compare
|
I converted it to ReST and made it clear that that example was merging I also added a note about release branches since it seems we're bringing them back. |
|
Also updated demo version here (same link as before). |
|
Looks good to me. And since it is now ReST, I think it would be nice to add a table of contents to the beginning of the file, perhaps with depth=1? |
dwlehman
force-pushed
the
contributing-update
branch
from
16ca008
to
5d40f94
Compare
I tried to make it much shorter to increase the chances of people actually reading the whole thing. I also converted it to ReST so it will render nicely on github.
dwlehman
force-pushed
the
contributing-update
branch
from
5d40f94
to
e5a0764
Compare
You can see a preview of what it will look like here.