Skip to content

Commit

Permalink
Merge branch '17-documentation-template-r-code' of https://github.com…
Browse files Browse the repository at this point in the history
…/pharmaverse/sdtm.oak into 17-documentation-template-r-code
  • Loading branch information
rammprasad committed Jan 24, 2024
2 parents d6fb1ee + 1f594cb commit e882c6e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This outlines how to propose a change to the sdtm.oak package. For more detailed

Please note that we try to align to best practices used in other R packages' development processes - so veteran developers should be familiar with our processes. However, we do deviate slightly from some best practices and we advise all new contributors to review our package documentation accordingly.


# Basics
* For each new contribution, the user creates an issue on the issue tab on [GitHub](https://github.com/pharmaverse/sdtm.oak/issues) to put it in our backlog.
The issues can range from bug identification and/or fixes, enhancements to
Expand All @@ -18,4 +19,4 @@ 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
of overall issues.
of overall issues.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
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/admiral/dev/CONTRIBUTING.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

0 comments on commit e882c6e

Please sign in to comment.