the-turing-way/the-turing-way

[BUG] Maintaining Consistency in overview-definitions.md

Open

#1,493 opened on Nov 1, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TeX (2,144 stars) (747 forks)batch import
buggood first issue

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 Definitions subchapter of the Overview chapter in the Guide to Reproducible Research. To help with this, we invite contributors to do the following:

File Specific Checklist

  • Convert image formatting from Markdown to MyST as described in the style guide
    • Add a descriptive ALT text to allow screen reading software to describe them well to its users
    • Do not give the image a height parameter as that will make the image appear distorted on mobile devices
  • Fix incorrect grammar and an inconsistent tone in the chapter
  • Change names of subchapters so that it is concise and maps exactly to its reference in the _toc.yml - change Definitions in table of contents to Definitions of Reproducibility
  • Make headers follow title-casing conventions (capitalise the first, last and 'important' words of every title; for example, 'Snow White and the Seven Dwarves'.) - Title-case Table of definitions for reproducibility, Reproducible but not open
  • Add labels to headers to enable cross-referencing as described in the style guide - add a label to Reproducible but not open

How you can help

  1. Please pick a consistency check from the checklist above (check it off from the issue description)
  2. Comment below what consistency check you would like to work on
  3. Work on your contributions locally or on Github
  4. 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:

Contributor guide