Developing a process for issue review and contributions

ga4gh / quality-control-wgs

Home for the GA4GH Quality Control of Whole Genome Sequencing metrics and reference implementations

https://www.ga4gh.org/product/wgs-quality-control-standards/

Apache License 2.0

7 stars 3 forks source link

Developing a process for issue review and contributions #1

Closed lindsmith closed 1 year ago

lindsmith commented 1 year ago

To ensure good work practices, we need to decide upon a process for contributing to the repo. Following up to our Dec. 13th call, I have reviewed the issues/PR processes followed in other GA4GH projects and prepared a PR for review. Some thoughts to consider:

Do we want to include some kind of formal voting/review as part of PR approval? Right now, community review is implied in

Open issues and PRs are reviewed and triaged in our QC of WGS calls.
Would it be useful to include definitions of product maintainer, contributor, subgroup lead, etc.?
Do we want to create PR/Issue templates for contributors?
Do we want instructions on how we'd prefer use of Github labels, milestones, and the project board?
Not yet described are Github features like code review limits. Do we want to enable any of these features?

Examples: VRS Development Process, VRS CONTRIBUTING.md, TRS CONTRIBUTING.md, Phenopackets CONTRIBUTING.md

ohofmann commented 1 year ago

@lindsmith Thanks for starting the discussion! Do we general templates for GA4GH repos for some of these? I suspect PR/issue templates could be relatively generic, as could be an agreed-upon set of labels as starting points and what the expectations for maintainer and contributors are. Happy to go with ad hoc definitions for now and use them to start a broader discussion.

lindsmith commented 1 year ago

@ohofmann Unfortunately no general use templates yet, but this has been submitted as a best practice need (see the Airtable board) for further development & discussion.

I think we will need to go with our own ad hoc definitions for now. I agree - let's share our decisions to generate some broader discussion. I'm assuming the Best Practices team will be reaching out to groups in the future to collect this information anyway.

ohofmann commented 1 year ago

Okay! @skanwal - can you work with Alexis and the team to port over some of our ICA (and UMCCR) templates for reports/issues or PRs?

skanwal commented 1 year ago

Hi @lindsmith - Re adding templates for issues and PRs, I am not able to access "Settings" for this repository. I think because I am not part of GA4GH github org.

Is it possible for you to add me?

lindsmith commented 1 year ago

Hi @skanwal - I updated the permissions, can you access the settings now? Please let me know if not and I have one other fix to try.

skanwal commented 1 year ago

That worked, Lindsay, Thanks.

skanwal commented 1 year ago

Spoke too soon. I am only able to view limited options in "Settings". Ability to setup templates is still not accessible.

lindsmith commented 1 year ago

@skanwal - ok, you are now an admin to the repo! Working now?

skanwal commented 1 year ago

Yes, I can see complete options now. Thanks. I plan to set-up templates next week.