The-turing-way: [BUG] Maintaining Consistency in reviewing-workflow.md

Created on 7 Nov 2020  路  1Comment  路  Source: alan-turing-institute/the-turing-way

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

File Specific Checklist

  • [x] remove all HTML formatting
  • [x] reduce all header levels by 1 (for example ## becomes #).
  • [x] title case all headers too (change Typical workflows to Typical Workflows)
  • [ ] fix dead internal links by following cross-referencing guideline in the style guide
  • [ ] check for correct grammar and consistent tone

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:

bug good first issue gsod2020 retrospective consistency

Most helpful comment

Actions:

  • remove all HTML formatting
  • reduce all header levels by 1 (for example ## becomes #)
  • title case all headers too (change Typical workflows to Typical Workflows)

>All comments

Actions:

  • remove all HTML formatting
  • reduce all header levels by 1 (for example ## becomes #)
  • title case all headers too (change Typical workflows to Typical Workflows)
Was this page helpful?
0 / 5 - 0 ratings

Related issues

malvikasharan picture malvikasharan  路  4Comments

malvikasharan picture malvikasharan  路  5Comments

sgibson91 picture sgibson91  路  5Comments

sgibson91 picture sgibson91  路  5Comments

sdruskat picture sdruskat  路  4Comments