Skip to content

Commit a2d3e6e

Browse files
authored
mention GitHub Discussions and GitHub issue templates (#497)
1 parent 331235f commit a2d3e6e

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

booknews.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## dev (0.9.0)
44

5+
- 2022-07-21, mention GitHub Discussions and GitHub issue templates. (#482)
6+
57
- 2022-07-21, highlight values for reviewing in more places (#481)
68

79
- 2022-07-20, Explanation of package submission via non-default branches (#485), added `@s3alfisc` to contributor list.

maintenance_collaboration.Rmd

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,15 @@ Once a pull request is closer to being merged, you could use [a GitHub Actions P
5858

5959
By using GitHub features around issues you can help potential contributors find them, and make your roadmap public.
6060

61+
#### Issue templates
62+
63+
You could use one or several [issue template(s)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates=) to help users fill better bug reports or feature requests.
64+
When there are several issue templates, users who click on opening a new issue see a menu that guide their choices.
65+
66+
You can even [configure one of the choices](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser=) to point to somewhere outside of your repository (for instance a discussion forum).
67+
68+
Refer to [GitHub docs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository).
69+
6170
#### Issue labelling
6271

6372
You can use labels such as "help wanted" and "good first issue" to help potential collaborators, including newbies, find your repo. [Cf GitHub article](https://help.github.com/articles/helping-new-contributors-find-your-project-with-labels/). You can also use the "Beginner" label. See [examples of beginner issues over all ropensci repos](https://github.com/search?q=user%3Aropensci+user%3Aropenscilabs+label%3ABeginner+state%3Aopen&type=Issues).
@@ -71,6 +80,11 @@ It can help advertise what your priorities are.
7180

7281
You can [create milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) and assign issues to them, which help see what you plan for the next version of your package for instance.
7382

83+
### Communication with users
84+
85+
You can point users to rOpenSci forum if you monitor it, or enable [GitHub Discussions](https://docs.github.com/en/discussions) for your package repository.
86+
Each GitHub discussion can be converted to an issue if needed (and the other way round, issues can be converted to discussions).
87+
7488
## Working with collaborators {#workingcollaborators}
7589

7690
First thing first: keep in touch with your GitHub repository!

0 commit comments

Comments
 (0)