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

Include authorship/copyright notes and address code overlap #14

Closed
yoelcortes opened this issue May 16, 2020 · 1 comment
Closed

Include authorship/copyright notes and address code overlap #14

yoelcortes opened this issue May 16, 2020 · 1 comment
Assignees
Labels
code overlap Code reuse, refactoring, and authorship/licensing issues
Milestone

Comments

@yoelcortes
Copy link
Member

yoelcortes commented May 16, 2020

Most modules in the thermosteam.properties subpackage and a couple of modules elsewhere originated from thermo. Although most have been enhanced/altered, it is important to credit the original author. To address this issue, a comment header will be added to each copied/modified file noting the origin, authors and license. Also, all authorship, date, and license information will be removed from the module docstring and be placed as a comment block for both consistency and keeping the documentation concise.

Additionally, it may be possible to contribute back the enhancements made to these files to the thermo repository and use thermo as a third-party dependency for better code reuse and management. Alternatively, it is also possible to work with the original author of these files to create a lower-level package that can work as a better dependency for thermo, thermosteam, and other packages.

@yoelcortes yoelcortes self-assigned this May 16, 2020
@yoelcortes yoelcortes added the code overlap Code reuse, refactoring, and authorship/licensing issues label May 16, 2020
@yoelcortes yoelcortes added this to the v1.0 milestone May 16, 2020
@yoelcortes yoelcortes changed the title Include authorship/copyright notes and adress code overlap Include authorship/copyright notes and address code overlap May 16, 2020
@yoelcortes
Copy link
Member Author

The copyright, license, and author attributions have been added to all files. Currently working with the author of thermo to release a manageable, standalone, lower-level package to serve as a better dependence for thermosteam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code overlap Code reuse, refactoring, and authorship/licensing issues
Projects
None yet
Development

No branches or pull requests

1 participant