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

Add to CONTRIBUTIONS document a explanation of how to contribute to this package #4

Open
wfmackey opened this issue Apr 17, 2021 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation for current version Issue to be addressed before release of next version. help wanted Extra attention is needed

Comments

@wfmackey
Copy link
Collaborator

To encourage/allow members of the runapp group to contribute to this package, it'd be useful to detail the steps to actually do it.

This could be hosted entirely on the README, or the README could point to a blogpost/explainer hosted elsewhere.

@wfmackey wfmackey added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 17, 2021
@wfmackey
Copy link
Collaborator Author

This should also include what steps are required to update the pkgdown site. @mrjoh3 can you post them here?

@mrjoh3
Copy link
Collaborator

mrjoh3 commented Apr 19, 2021

@wfmackey can do. If you look at the pkgdown repo they have a CONTRIBUTING.md and CODE_OF_CONDUCT.md files within the .github folder, see here. It look like these get picked up automatically when the pkgdown site renders.

If you agree I will create the two files and add a section to contributing on pkgdown?

@mrjoh3
Copy link
Collaborator

mrjoh3 commented Apr 19, 2021

for the code of conduct I will copy across the runapp COD https://runapp-aus.github.io/runapp_website/code-of-conduct.html

@wfmackey
Copy link
Collaborator Author

Excellent! Go for it.

@wfmackey wfmackey changed the title Add detailed explanation of how to contribute to this package Add to CONTRIBUTIONS document a explanation of how to contribute to this package Apr 19, 2021
@bryceroney
Copy link
Contributor

Just realised I've been assigned to this! Happy to help if there is anything in particular? @mrjoh3 are you still working on a CONTRIBUTING.md file?

@bryceroney
Copy link
Contributor

Silly me, it's already been added. I assume this issue can be closed then?

@mrjoh3
Copy link
Collaborator

mrjoh3 commented May 6, 2021

@bryceroney I put the CONTRIBUTING file together pretty quickly, I suspect it could do with more detail and addition sections could be added.

@bryceroney
Copy link
Contributor

Cool, I'll take a better look over the weekend. As well as Issue/PR templates etc.

@wfmackey wfmackey added the for current version Issue to be addressed before release of next version. label Jun 1, 2021
@wfmackey wfmackey added this to the Stable version 1.0 release milestone Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation for current version Issue to be addressed before release of next version. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants