Updated CONTRIBUTING.rmd file instructions #639
Conversation
Removed excessive line breaks to make organization clearer for future modifications, made some small style revisions, clarified the instructions for how to contribute via GitHub, and fixed broken links to the repository.
|
Hi @wclose thanks for the contribution, but I think this should go in https://github.com/swcarpentry/lesson-example/blob/gh-pages/CONTRIBUTING.md so we can pull it into this repo. Is that correct @rgaiacs ? |
|
@wclose Thanks for the pull request.
Excessive line breaks is a matter of preference. I created carpentries/lesson-example#134 to explain why we use "excessive line breaks". It should be better documented before but we forget. I'm happy to review our previous decision but if you want to start this discussion keep in mind that inclusion/diversity will be in first place against text editor preference.
Would be great to port the changes to https://github.com/swcarpentry/styles/blob/gh-pages/bin/lesson_initialize.py#L18. I'm very unhappy if that file but until I can convince others to change, it is the place to do the changes.
I imagine that the broken links are Every time that we run bin/lesson_initialize.py the links will broke. This is the reason why I want to get ride of that file but do it isn't easy. And update |
|
Thanks @gdevenyi and @rgaiacs for the input and sorry for not getting back to you more quickly. I made the changes and submitted them to https://github.com/swcarpentry/styles/blob/gh-pages/bin/lesson_initialize.py#L18 as you requested. I also changed the links that contained FIXME to something close that doesn't require adjustment after initialization. The new pull request can be found at carpentries/styles#188. Thanks again! |
|
Thanks! |
* Updated lesson_initialize Clarified instructions for using GitHub to contribute, altered link for [issues] to direct to GitHub page on navigating issues to avoid FIXME issue with link when initializing, removed link to master repo to avoid FIXME issue with link when initializing. These suggestions were based on a pull request initially done elsewhere swcarpentry/shell-novice#639 * Made requested revisions to lesson_initialize Changed the keyword for emailing from 'contact' to 'email' per carpentries/styles#178 and changed the description for how to use GitHub to reflect usage of the web interface. * Made minor revision to order of information Reorganized description of process for contributing to clarify/increase readability * Fix CSS to use .language-X class * fix svg files * Add current year to copyright of workshop footer * Fix broken link for Contact * Requested changes * Fix issue with CSS * Update CONDUCT.md * updated license following this https://creativecommons.org/licenses/by/4.0/deed.es insead of usted tu * fix link referrence * r reproducible * r reproducible * r reproducible * translate overview and teaching * change finish for Final * Update schedule.html Traducido * translate 'finish' to 'final as per swcarpentry/r-novice-gapminder-es#53 * translate 'cite' to 'cita' as per swcarpentry/r-novice-gapminder-es#54
Clarified instructions for using GitHub to contribute, altered link for [issues] to direct to GitHub page on navigating issues to avoid FIXME issue with link when initializing, removed link to master repo to avoid FIXME issue with link when initializing. These suggestions were based on a pull request initially done elsewhere swcarpentry/shell-novice#639
modify transition workflow/variables
Removed excessive line breaks to make organization clearer for future modifications, made some small style revisions, clarified the instructions for how to contribute via GitHub, and fixed broken links to the repository.