ropensci / ropensci/dev_guide

Should design simplicity be a criterion in the reviewing guide

Open Beginner friendly
#1,039 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
164
Forks
69
Avg merge
5d 23h
Merged PRs (30d)
5

Description

Would it make sense to add something such as

- Could the design of the package be simplified to help future maintenance? 

I am not sure about this / the phrasing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the reviewing guide section where package design or maintenance criteria are discussed. Review the proposed criterion and surrounding guidance, then update the guide once the wording and inclusion are agreed; done means the criterion is clear and fits the existing review checklist.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.