the-turing-way/the-turing-way

[BUG] Maintaining Consistency in reviewing-resources.md

Open

#1,519 opened on Nov 7, 2020

View on GitHub
 (1 comment) (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 Resources 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

  • Lots of content in the file is missing. Remove the reference to it from the _toc.yml and raise an issue for content to be written for it

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

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue asks to remove the reference to the file `reviewing resources.md` from ` toc.yml` and raise a new issue for content to be written. The file location is `book/website/reproducible research/reviewing/reviewing resources.md`. The maintainers referenced a PR (#1459) for the consistency chapter that provides instructions. The contributor should edit the ` toc.yml` file in the repository to remove the link, then create a new issue describing the missing content.