-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomersgood for beginnershelp wantedExtra attention is neededExtra attention is needed
Description
It has recently dawned on me that although we do have a contributing guide, it could be better. Especially with respect to creating new functions for OCC, how to test out functions for OCC, and more. Generally speaking, I think a better way of outlining how to develop new OCC functions would be great. In particular, this process for creating new functions could look something like:
- Download HealthSampleData
- Run the
Eunomiafunction and create a connection to the database usingSQLite GenerateTablesbut set export equal to true so one can have FunSQL representations of the OMOPCDM tables to play with- Link to the FunSQL tutorials
- Walk through an example of how to build a new function
- Include tests
- Include dispatches
- Include documentation details
- Finalize walk through with how to submit a PR
I think this would be great and could help more with onboarding as well as making our general process more clear. It uses a lot from the original tutorial here: https://juliahealth.org/OMOPCDMCohortCreator.jl/stable/tutorials/beginner_tutorial/
What do you think @Jay-sanjay and @Farreeda ? Am I missing anything general in this outline?
Jay-sanjay
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomersgood for beginnershelp wantedExtra attention is neededExtra attention is needed