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

align included license files with current Rust project best practices #4

Merged
merged 1 commit into from
Jul 14, 2023
Merged

Conversation

decathorpe
Copy link
Contributor

Hi! I'm currently working on packaging this crate for Fedora Linux as a dependency of hashbrown v0.14.0 and bumpalo, and noticed that the setup for license files in this repository is currently quite unusual for a Rust project (and also non-compliant with the Apache-2.0 license, since it requires the full license text to be included, not only the header).

I've made some changes to align this project with other Rust projects and best practices, i.e. renamed license files to LICENSE-APACHE, LICENSE-MIT, and removed the COPYING file which is redundant with the ## License paragraph from the README (and which also included the wrong paths for the Apache-2.0 / MIT license texts).

The end result is equivalent to the setup in the repo for the proc-macro2 crate (which I took as a reference because both proc-macro2 and allocator-api2 are reimplementations of Rust features), and the rust-lang/rust project itself - notable changes include:

  • include full Apache-2.0 license text in LICENSE-APACHE (without appendix; see ¹ and ²)
  • remove copyright from MIT license (this is an anachronism and a noop; see ³ and ⁴)

¹ rust-lang/rust@2ccf65c
² dtolnay/proc-macro2@37e89e1
³ rust-lang/rust@2a8807e
dtolnay/proc-macro2@f633e31

@zakarumych zakarumych merged commit 6a67e3c into zakarumych:main Jul 14, 2023
@zakarumych
Copy link
Owner

Thank you for the contribution

@decathorpe
Copy link
Contributor Author

Thanks for merging! 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants