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.

Sign up for GitHub

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

Jump to bottom

Clarify and document reviewing process for user contributed scripts and pipelines #135

Open
jmlord opened this issue Dec 20, 2023 · 3 comments · May be fixed by #188
Open

Clarify and document reviewing process for user contributed scripts and pipelines #135

jmlord opened this issue Dec 20, 2023 · 3 comments · May be fixed by #188
Labels
documentation Improvements or additions to documentation
Milestone
Training material

Comments

@jmlord
Copy link
Contributor

jmlord commented Dec 20, 2023 •
edited
Loading

This should go in one of the qmd files, perhaps in contributing pipelines, or perhaps separate the contribution workflow from the techy file description info into two separate pages? It should contain:

  • A checklist of what to have before review
  • An explanation of the review process
  • An additional checklist of what is required post acceptance in order to figure on the website in the examples (one or more good example runs, text for a webpage)
@jmlord jmlord converted this from a draft issue Dec 20, 2023
@jmlord jmlord added the documentation Improvements or additions to documentation label Dec 20, 2023
@jmlord jmlord added this to the Training material milestone Dec 20, 2023
@jmlord jmlord moved this to Backlog in BON in a Box pipelines Feb 20, 2024
@jmlord jmlord moved this from Backlog to TODO in BON in a Box pipelines Oct 10, 2024
@jmlord
Copy link
Contributor Author

jmlord commented Oct 10, 2024

Jory and I will come to this eventually, but if someone knowledgeable of the project wants to make a first draft, it's most welcome!

@tpoisot
Copy link

tpoisot commented Oct 10, 2024

I think something like Freckleton (2018) + the checklist that the editorial board came up with would be good.

If I may make a suggestion: PR template in addition to / instead of a qmd document?

(this also counts as me volunteering to assist with this)

@jmlord
Copy link
Contributor Author

jmlord commented Oct 10, 2024

If I may make a suggestion: PR template in addition to / instead of a qmd document?

Yes! I would see a PR template with a checklist and referring to that more complete documentation.

(this also counts as me volunteering to assist with this)

That is most welcome :)

@tpoisot tpoisot linked a pull request Oct 17, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
BON in a Box pipelines
Status: TODO
Milestone
Training material
Development

Successfully merging a pull request may close this issue.

Info on the peer review process + pull request template GEO-BON/bon-in-a-box-pipelines
2 participants
@tpoisot @jmlord