Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use SUPPORT #166

Closed
jennybc opened this issue Dec 28, 2017 · 6 comments
Closed

Use SUPPORT #166

jennybc opened this issue Dec 28, 2017 · 6 comments

Comments

@jennybc
Copy link
Member

@jennybc jennybc commented Dec 28, 2017

Should we? For tidyverse packages, we have obvious places to link to, e.g. contributing guidelines, community.rstudio.com, non-code contributions.

https://help.github.com/articles/adding-support-resources-to-your-project/

@batpigandme
Copy link
Member

@batpigandme batpigandme commented Dec 28, 2017

Yep. On it

@jennybc jennybc closed this in #171 Dec 30, 2017
jennybc added a commit that referenced this issue Dec 30, 2017
* Add support guidelines
* Closes #166.

* 📋 Friendlies, and listifies support template
* Put reprex first
* Bullet the possible places
* In-line link to issues search
@timtrice
Copy link

@timtrice timtrice commented Jul 20, 2019

At https://github.com/r-lib/usethis/blob/2d3230238828d0a9ec5f441c858142229a0a9495/inst/templates/SUPPORT.md line 23, the URL points to https://github.com/tidyverse/{{{package}}}/issues to search for issues. Shouldn't this actually point to the project repo?

I'd be happy to fix if need be.

@jennybc
Copy link
Member Author

@jennybc jennybc commented Jul 20, 2019

Shouldn't this actually point to the project repo?

Are you pointing out the fact that this is hard-wired to the tidyverse org?

I believe this template is only used by use_tidy_*() functions (but I could be wrong), so the guarantee is only that they work for tidyverse packages.

@timtrice
Copy link

@timtrice timtrice commented Jul 20, 2019

Are you pointing out the fact that this is hard-wired to the tidyverse org?

Correct. I'm under the impression any of the use_tidy_*() functions can be used to create templates in our own packages or projects. In this instance, the SUPPORT template would be directing readers to search tidyverse/my_project for previously reported issues or PRs which, of course, would be the incorrect path.

@jennybc
Copy link
Member Author

@jennybc jennybc commented Jul 20, 2019

The use_tidy_*() functions were originally conceived for use in tidyverse packages. But I think it's true that the reality or perception has drifted more towards doing things in the style of a tidyverse package. We have so much infrastructure around tithe GitHub side of things now that it is probably fairly straightforward to generalize the template to use the correct OWNER/REPO here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants