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

Update docs and links. #34

Merged
merged 2 commits into from
Jan 18, 2024
Merged

Update docs and links. #34

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcaea2b
Update docs and links.
galachad Jan 18, 2024
019c62f
Update .github/CONTRIBUTING.md
galachad Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Contribution to {oak}
# Contribution to {sdtm.oak}

This outlines how to propose a change to the aok package. For more detailed info
about contributing to {oak}, and other [pharmaverse
galachad marked this conversation as resolved.
Show resolved Hide resolved
about contributing to {sdtm.oak}, and other [pharmaverse
packages](https://pharmaverse.org/), please see the [development process
guide](https://pharmaverse.github.io/admiraldev/articles/development_process.html)
guide](https://pharmaverse.github.io/sdtm.oak/CONTRIBUTING.html)
as well as other Developer Guides in the Articles section of the [{admiral}
website](https://pharmaverse.github.io/admiral/cran-release/index.html)
website](https://pharmaverse.github.io/admiral/index.html)

# Basics
* For each new contribution, the user creates an issue on the issue tab on [GitHub](https://github.com/pharmaverse/oak/issues) to put it in our backlog.
Expand All @@ -17,7 +17,7 @@ functions, documentation, tests or new features.
[Slack](https://oakgarden.slack.com) (If you don't have access, use this
[link](https://join.slack.com/t/oakgarden/shared_invite/zt-204sf8w5c-Vxl71cI~WAYhsMLbHGxeMw)
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
with the `{sdtm.oak}` philosophy and programming strategy. The team will try to
review the issues within the next backlog meeting 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
Expand All @@ -42,17 +42,17 @@ community.
* First, the user creates an issue or comments on an existing issue to notify
that they’d like to contribute code.
* Follow our development process step-by-step guide.
* We advise to contact an `{oak}` core development team directly via [Slack](https://app.slack.com/client/T028PB489D3/C02M8KN8269) before submitting code for complex functionality.
* We advise to contact an `{sdtm.oak}` core development team directly via [Slack](https://app.slack.com/client/T028PB489D3/C02M8KN8269) before submitting code for complex functionality.


## Type 2 Contribution without Code:

* User creates an issue and ideally contacts an `{oak}` team member via [Slack](https://oakgarden.slack.com).
* The `{oak}` core development team will contact the issue creator as soon
* User creates an issue and ideally contacts an `{sdtm.oak}` team member via [Slack](https://oakgarden.slack.com).
* The `{sdtm.oak}` core development team will contact the issue creator as soon
as possible to discuss further details.


See [Contribution to {admiral}](https://pharmaverse.github.io/admiral/cran-release/articles/contribution_model.html) for additional details.
See [Contribution to {admiral}](https://pharmaverse.github.io/admiral/articles/contribution_model.html) for additional details.

# Containers guideline

Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Thank you for your Pull Request! We have developed this task checklist from the
[Development Process
Guide](https://pharmaverse.github.io/admiraldev/articles/development_process.html)
Guide](https://pharmaverse.github.io/sdtm.oak/CONTRIBUTING.html)
to help with the final steps of the process. Completing the below tasks helps to
ensure our reviewers can maximize their time on your code as well as making sure
the oak codebase remains robust and consistent.
Expand Down Expand Up @@ -31,7 +31,7 @@ and families. Refer to the
- [ ] Update `NEWS.md` if the changes pertain to a user-facing function (i.e. it
has an `@export` tag) or documentation aimed at users (rather than developers)
- [ ] Build oak site `pkgdown::build_site()` and check that all affected
examples are displayed correctly and that all new functions occur on the "[Reference](https://pharmaverse.github.io/admiral/cran-release/reference/index.html)" page.
examples are displayed correctly and that all new functions occur on the "[Reference](https://pharmaverse.github.io/admiral/reference/index.html)" page.
- [ ] Address or fix all lintr warnings and errors - `lintr::lint_package()`
- [ ] Run `R CMD check` locally and address all errors and warnings - `devtools::check()`
- [ ] Link the issue in the Development Section on the right hand side.
Expand Down
Loading