[BUG] Maintaining Consistency in overview.md
#1,484 opened on Oct 31, 2020
Description
Summary of Issue
The Turing Way project is an open-source endeavour that empowers contributors from around the world to leverage their skills, knowledge and expertise to build and expand its content. The Turing Way guides are evolving with multiple chapters co-developed by individuals from varied backgrounds, who are all passionate about sharing knowledge around data science and research. To sustain and support this vibrant community, The Turing Way book must remain consistent and accessible as it evolves. Although the style guide chapter already outlines guidelines for keeping a consistent style across the book, not all chapters follow these suggestions as they have been written asynchronously by different authors.
We have curated a consistency checklist that chapters in The Turing Way need to pass to help us maintain a consistent style across the book. However, we need your help to push this forward!
For reference, the checklist is discussed in the chapter on maintaining consistency in The Turing Way. There you can also find useful instructions on how to address these issues
At the time that this issue was created, the maintaining consistency chapter is yet to be merged. However, you can check out the PR here
What needs to be done
This issue focuses on maintaining consistency in the landing page of the Overview Chapter of the Guide to Reproducible Research. To help with this, we invite contributors to do the following:
- File Location: book/website/reproducible-research/overview.md
- Latest commit when this issue was created: fc482bc
File Specific Checklist
- Add labels to headers and images to enable cross-referencing as described in the style guide
- Add a label to the
Prerequisites/Recommended Skill Levelsection
- Add a label to the
- Fix chapter structure by ensuring it follows the predefined structure described in this chapter template
- Move
Prerequisites/Recommended Skill Levelsection above chapter summary - Give chapter summary a level 2 heading called
Summary - Rename
Prerequisites/Recommended Skill LeveltoPrerequisites
- Move
- Fix all incorrect grammar and an inconsistent tone in the file
- Correct inconsistent language use by ensuring that the file only uses one language style (British English or American English).
- Change chapter name so that it matches its reference in the
_toc.ymlfile- Change name from
Overview of Reproducible ResearchtoOverview
- Change name from
How you can help
- Please pick a consistency check from the checklist above (check it off from the issue description)
- Comment below what consistency check you would like to work on
- Work on your contributions locally or on Github
- Raise a PR for your contributions to be reviewed and integrated in The Turing Way repo!
Who can help
Anyone who would like to make the The Turing Way as consistent and polished as possible. We especially welcome new contributors to try their hand on this!
For any questions, comments, suggestions, or feedback, please comment below :muscle: