reST fixes for contributors files #878
Conversation
Current coverage is 100% (diff: 100%)@@ master #878 diff @@
====================================
Files 17 17
Lines 685 685
Methods 0 0
Messages 0 0
Branches 0 0
====================================
Hits 685 685
Misses 0 0
Partials 0 0
|
There was a problem hiding this comment.
Thank you @stevepiercy for this PR! 🙇
Can you please revert the newline changes in CONTRIBUTING.rst? It now has Windows ^M line feeds.
|
I wondered what that meant in GitHub. I got this from the master branch. Strange how it was not caught until I ran it |
| Note: this project is very conservative, so new features that aren't tagged | ||
| with "please-help" might not get into core. We're trying to keep the code base | ||
| small, extensible, and streamlined. Whenever possible, it's best to try and | ||
| implement feature ideas as separate projects outside of the core codebase. |
There was a problem hiding this comment.
It looks like this text was updated directly in CONTRIBUTING.rst and not in docs/types_of_contributions.rst, could you please fix this?
There was a problem hiding this comment.
@michaeljoseph on my branch, docs/types_of_contributions.rst is current with master (except the changes I made after pulling from master). I think that someone may forgotten to run make contributing and commit CONTRIBUTING.rst at some point, so the source files were getting updated but not the concatenation. I nearly missed it myself.
There was a problem hiding this comment.
@stevepiercy I think the issue here is that the concatenation got updated, but not the source file.
There was a problem hiding this comment.
@michaeljoseph OK, I double-checked, and I found that both the commit history and the raw content of the file docs/types_of_contributions.rst on both audreyr/master and stevepiercy/rest-syntax are identical.
Compare history:
- https://github.com/audreyr/cookiecutter/commits/master/docs/types_of_contributions.rst
- https://github.com/stevepiercy/cookiecutter/commits/rest-syntax/docs/types_of_contributions.rst
Compare source:
- https://raw.githubusercontent.com/audreyr/cookiecutter/master/docs/types_of_contributions.rst
- https://raw.githubusercontent.com/stevepiercy/cookiecutter/rest-syntax/docs/types_of_contributions.rst
Do you see something that I missed?
In the commit you linked to, it appears that @audreyr on Jun 7, 2016 made the commit to only 1 file, /CONTRIBUTING.rst, but not the source file.
Would you like me to take the changes from @audreyr's commit in /CONTRIBUTING.rst and put them into docs/types_of_contributions.rst on my branch, then render /CONTRIBUTING.rst again and commit both files? I think that is what you want in the end, but want to confirm. Thank you!
There was a problem hiding this comment.
Would you like me to take the changes from @audreyr's commit in /CONTRIBUTING.rst and put them into docs/types_of_contributions.rst on my branch, then render /CONTRIBUTING.rst again and commit both files?
Yes please :) Thanks for being so much clearer than my request 👍
There was a problem hiding this comment.
Fixed in bace552
| cat docs/core_committer_guide.rst >> CONTRIBUTING.rst | ||
| echo "\r\rAutogenerated from the docs via \`make contributing\`" >> CONTRIBUTING.rst | ||
| echo "WARNING: Don't forget to replace any :ref: statements with literal names" | ||
| WARNING: Don't forget to replace any :ref: statements with literal names |
There was a problem hiding this comment.
Can we update this in docs/core_committer_guide.rst to be consistent with your change in the Makefile?
Alternatively, I'm not opposed to just removing this output entirely.
There was a problem hiding this comment.
Fixed in 77d44ad
| Note: this project is very conservative, so new features that aren't tagged | ||
| with "please-help" might not get into core. We're trying to keep the code base | ||
| small, extensible, and streamlined. Whenever possible, it's best to try and | ||
| implement feature ideas as separate projects outside of the core codebase. |
There was a problem hiding this comment.
@michaeljoseph on my branch, docs/types_of_contributions.rst is current with master (except the changes I made after pulling from master). I think that someone may forgotten to run make contributing and commit CONTRIBUTING.rst at some point, so the source files were getting updated but not the concatenation. I nearly missed it myself.
…bbbc587R56 in /CONTRIBUTING.rst and put them into `docs/types_of_contributions.rst`, rerender `/CONTRIBUTING.rst`
|
Thanks @stevepiercy 🎉 |
|
Woohoo! Thank you @stevepiercy 👏 |
No description provided.