Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add a CONTRIBUTING.md?

Open
#96 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
r
Domain
documentation

Research direction

Start with the requested CONTRIBUTING.md and the snapshot-testing instruction in the issue. Check how the package currently documents test commands, then ensure the guide explains that updating snapshots requires installing the package and running testthat::test_local(load_package = "none").

Written by the indexing model from the issue text.

Description

help wanted

I think it would be worth adding this to a CONTRIBUTING.md for the package, as some tests should be run differently.


For updating snapshots, it requires installing the package and running testthat::test_local(load_package = "none") .

Originally posted by @krlmlr in https://github.com/r-lib/rprojroot/issues/86#issuecomment-1793648597

Dominant language
R
Stars
150
Forks
29
Avg merge
3m
Merged PRs (30d)
6

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from r-lib/rprojroot

All issues in r-lib/rprojroot

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.