-
Notifications
You must be signed in to change notification settings - Fork 7
Contribution to {sdtm.oak}
This guide gives you an overview of the anticipated contribution model. The goal is to enable users of oak to contribute and test the contribution model for oak. Adjustments might be made over time.
Our contribution model is still in a testing phase so we advise you to contact us when an issue is created via Slack (If you don’t have access, use this link to join). We can discuss details or align expectations if you are not familiar with the oak philosophy and programming strategy. The team will try to review the issues within the next sprint and give some initial feedback. Since we are not a 100% fully resourced software development team it might be that some issues will take longer to respond to depending on the amount of overall issues.
-
For each new contribution, the user creates an issue on the issue tab on GitHub to put it in our backlog.
-
Familiarize yourself with our programming strategy, guidance for GitHub usage and unit testing.
-
All created issues will be reviewed within the next sprint and the creator will receive an initial feedback via a comment. Someone from the core development team will then triage new issues by Oeassigning the appropriate labels (such as “user request” so we can easily identify new requests).
-
Issues are meant to be taken on by users from the Pharma programming community.
Every contribution starts with a new issue in the oak GitHub project board for a bug fix, improvement, enhancement (additional/new feature or documentation) of existing function, new functionality (code/documentation). Oak core team reviews requests and contacts the user to set expectations and makes an “in scope of oak” decision.
- First, the user creates an issue or comments on an existing issue to notify others that they’d like to contribute code.
- Follow our development process step-by-step guide.
- We advise you to contact an oak core development team directly via Slack before submitting code for complex functionality.
User creates an issue and ideally contacts oak team members via Slack. The oak core development team will contact the issue creator as soon as possible to discuss further details. The functionality will be implemented by the oak development team.
Oak team will review and test the contributed functionality to ensure implementation is following programming strategy. The new functionality will be released with the next version of oak.
- It should take up to 2 weeks for the oak core team to make a decision.
- The length of the implementation phase depends on the availability of a developer/reviewer and the complexity of the change.
- Part of this document has been adapted from admiral
- https://pharmaverse.org/contribute/ic/