search

elixir-cloud-aai / CrateGen

Compile GA4GH WES and TES requests from Workflow Run RO-Crates and package WES and TES runs as Workflow Run RO-Crates
Apache License 2.0
0 stars 1 forks source link

Repository setup #7

Open Karanjot786 opened 2 weeks ago

Karanjot786 commented 2 weeks ago

Description

We need to set up the repository for the WRROC Converter project properly. This includes setting up packaging, dependency management, linting, static code/type checks, API documentation, and a CI pipeline to ensure a robust development environment.

Tasks

uniqueg commented 2 weeks ago

Thanks, @Karanjot786 - this looks very good. However, note that this issue will constitute more than one PR - which means that you can't link it to any individual PR (because addressing only one of the points shouldn't close the entire issue).

Best is to break it down and create individual issues for each of these points (1. - 4.), then convert this issue to a Task List issue, linking to the individual issues.

uniqueg commented 2 weeks ago

Because what you just now did (manually checking boxes, especially if they haven't even been merged) and linking this issue to one individual commit that does not fully address this issue (but by linking would close this issue upon merging the linked PR) is not very good.

If you have individual issues, it makes sense to link a PR to the issue and have it automatically closed when the PR is merged. And in a Task List, also the checkboxes are automatically checked when the referenced issue is closed.

uniqueg commented 2 weeks ago

Re-opened the issue...

uniqueg commented 2 weeks ago

Looks good. Note that I edited the issue description to put the [ ] in a list so that they would render properly and create a task list.

uniqueg commented 2 weeks ago

Also, no need to include check boxes in the individual issues (you currently have them in two issues), just put a normal list. Otherwise you need to remember to check the boxes, and chances are that you will forget that. If an issue is closed with a PR, it is assumed that all points are addressed, or otherwise differences are explained in the PR (and project documentation, if necessary).

Karanjot786 commented 2 weeks ago

Thank you for your feedback. I will update the individual issues to use a normal list instead of checkboxes to avoid the need to manually check them off. This will ensure that closing an issue with a PR assumes all points are addressed or differences are explained in the PR and project documentation if necessary.