Light

ropensci / dotgithubfiles Goto Github PK

View Code? Open in Web Editor NEW

11.0 3.0 8.0 12 KB

rOpenSci .github files

dotgithubfiles's Introduction

rOpenSci .github files

These templates are part of our guidance for package authors. Cf our gitbook in particular the chapter about collaboration.

Includes:

How to use the templates:

You can use the rodev::use_ro_github() function of rodev to perform all three steps at once, or

Put the content of dotgithub folder i.e. these three files in a .github directory in the base of your R package.
Update the CONTRIBUTING.md file with the package name.
Make sure to add a line with .github in your .Rbuildignore file in your package as well. E.g. run usethis::use_build_ignore(".github").

For more info on template files for GitHub repos:

Setting guidelines for repository contributors: https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Issue and PR templates: https://help.github.com/articles/about-issue-and-pull-request-templates/

Note: These files are mostly not specific to rOpenSci - there are a few items in the files specific to rOpenSci, but can be easily removed.

dotgithubfiles's People

Contributors

Stargazers

Watchers

Forkers

sfirke dombennett aurielfournier orchid00 fdschneider maurolepore mcfish mortisflux

dotgithubfiles's Issues

Urge those opening issues/PRs to not share API keys/other secrets

reminder people to check for these so they don't accidentally expose their secret tokens to the world

issue template: ask users to not use screenshots instead of code

it's maddening, and needs to be explicitly mentioned to hopefully reduce number of issues with screenshots rather than the actual code in text format

One... or several issue templates?

See e.g. https://github.com/yonicd/carbonate/tree/master/.github/ISSUE_TEMPLATE

Then when one click on "New issue" here's what one gets

Posting this here so that we can keep in mind this possibility of extending our issue templating.

what about r-lib verse

As @jennybc mentioned in ropensci/software-review-meta#13, sounds like devtools etc will soon be providinguse_ functions to create some of this? Obviously we can create our own as necessary, but for some of these maybe better to coordinate first with those efforts? I dunno, but I'm all for shared / common practices and fewer things we have to maintain independently... Perhaps @jennybc can weigh in more insightfully.

reorganize the files

since the 3 main files in this repo are not meant for targeting this repo itself, probably makes sense to put them in a folder, not named .github, but something else (e.g. dotgithub or so)

Rename repo to automatically work as default

I'm not sure if that's a new feature but it looks like GitHub allows the use of community-wide defaults for the Code of Conduct and the Contributing Guide. From what I understand, renaming this repo would allow rOpensci default CoC and Contributing Guide to appear in repo where maintainers have not set them up.

https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization

suggest reprex in issue template?

update the templates before inclusion in rodev

Make a PR to this repo with new versions of the templates
Put them in a dotgithub folder cf #3
Use them in a rodev helper function (because usethis templating functions mentioned in #4 don't exist yet I think?)
Mention the templates and function in dev_guide

quick comments re Contributing

Should the README or something note that Contributing is specific to ropensci? (it isn't really, other than the link to our discourse page, which means some people might adopt it with non-ropensci packages).

Should contributors be encouraged to file an issue discussing the proposed PR first? (excepting PRs to fix such things as documentation)?

suggest feature branch in PR template?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.