Skip to content

Improve accessibility of CONTRIBUTING.md #147

@LukasWallrich

Description

@LukasWallrich

I only recently discovered CONTRIBUTING.md - which could have prevented me from making some of the glossary mistakes. To avoid that, it might be worth adding a confirmation to the PR template that users have seen and followed that file?

Also, a key challenge seems to be to get the PR process right. Here it might be good to provide more extensive guidance (maybe derived from usethis), but rewritten to focus on webpage rather than R package content? It might also be helpful to distinguish content contributions and technical contributions, where content contributors may not need to engage with the local testing at all if they don't want to learn about it?

A minor step towards accessibility would be to add the usethis PR workflow that removes the need to deal with branches and figure out how to start a PR on github - instead, users only need to call pr_init() to create and switch to a new branch and pr_push() to push it and get to the right place to start the PR on GitHub.

Metadata

Metadata

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions