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.

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 copyright notice #89

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Update copyright notice #89

merged 1 commit into from
Aug 28, 2024

Conversation

ramiromagno
Copy link
Collaborator

@ramiromagno ramiromagno commented Aug 3, 2024

  • Add Copyright field to DESCRIPTION
  • Remove Appendix from the Apache 2 License
  • Add a NOTICE file as hinted by the text of the Apache License

Note that I'm aware that many R packages using the Apache 2 License do not make any of these changes that I am proposing here. I think they are important nonetheless, and invite you to read:


Thank you for your Pull Request! We have developed this task checklist from the
Development Process
Guide

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.

Please check off each taskbox as an acknowledgment that you completed the task
or check off that it is not relevant to your Pull Request. This checklist is
part of the Github Action workflows and the Pull Request will not be merged into
the devel branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull z
    Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the
    tidyverse style guide. Run
    styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should
    consider realistic data scenarios and edge cases, e.g. empty datasets, errors,
    boundary cases etc. - See
    Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you
    fully follow the
    deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords
    and families. Refer to the
    categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the
    NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • 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" 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.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

- Add Copyright field to DSCRIPTION
- Remove Appendix from the Apache 2 License
- Add a NOTICE file as hinted by the text of the Apache License

Note that I'm aware that many R packages using the Apache 2 License do not make any of these changes that I am proposing here. I think they are important nonetheless, and invite you to read:

- Original Apache 2 License text: https://www.apache.org/licenses/LICENSE-2.0
- https://www.linkedin.com/pulse/how-apply-apache-20-license-your-open-source-software-vladim%C3%ADr-gorej/
@ramiromagno
Copy link
Collaborator Author

ramiromagno commented Aug 3, 2024

@rammprasad , @galachad, @edgar-manukyan, @kamilsi, @ShiyuC, @yli110-stat697: I'm sure this PR is going to raise a nice heated debate, and I think it would be best to do it in a meeting, but also think that have something concrete to discuss about is also helpful, so here it is this commit / PR, and a few extra notes for your consideration:

Note that I'm aware that many R packages using the Apache 2 License do not make any of these changes that I am proposing here. I think they are important nonetheless, and invite you to read:

Copy link

github-actions bot commented Aug 3, 2024

Code Coverage

Package Line Rate Health
sdtm.oak 93%
Summary 93% (953 / 1021)

@ramiromagno ramiromagno linked an issue Aug 3, 2024 that may be closed by this pull request
@rammprasad rammprasad merged commit f9739b9 into main Aug 28, 2024
16 checks passed
@rammprasad rammprasad deleted the 0088-copyright-holders branch August 28, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Copyright holders are missing from the License file
3 participants