search

forrtproject / forrtproject.github.io

FORRT Website
https://forrt.org
Other
31 stars 18 forks source link

Improve accessibility of CONTRIBUTING.md #147

Open LukasWallrich opened 2 months ago

LukasWallrich commented 2 months ago

I only recently discovered CONTRIBUTING.md - which could have prevented me from making some of the glossary mistakes. To avoid that, might it be worth adding a pull request template that requests contributors to ensure that they follow the guidance in that file?

Based on what I have seen when supporting others to contribute, the main 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.

github-actions[bot] commented 1 week ago

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

LukasWallrich commented 1 week ago

Keep open