License and Credits Files 📑

Every package can include two additional files: LICENSE and CREDITS.md. These files are separate from documentation files like README.md and CHANGELOG.md, serving different purposes. While documentation files explain how to use your package, license and credits files provide important legal and attribution information. The license file (plain text) defines the terms of use, while the credits file (in Markdown format) acknowledges contributors and third-party resources.

LICENSE ⚖️

The LICENSE file contains the legal terms under which your package is distributed. It defines how others can use, modify, and distribute your code.

Common License Types:

  • MIT License: A permissive license that allows for virtually unrestricted use.
  • Apache License 2.0: Similar to MIT but provides explicit patent rights.
  • GNU GPL: Ensures that derivative works remain open source.
  • BSD License: A family of permissive licenses with minimal restrictions.
  • Custom License: Tailored to your specific requirements.

Structure:

A typical LICENSE file follows a standard format:

MIT License

Copyright (c) 2025 Your Name or Organization

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction...

Tips:

  • Choose a license that aligns with your intentions for the package.
  • Don't modify standard license texts unless absolutely necessary.
  • Include the full license text rather than just referencing a license type.
  • If you're unsure which license to use, the MIT License is a common choice for open-source projects.

CREDITS.md 👏

The CREDITS.md file acknowledges contributors, third-party libraries, and resources used in your package. It's an important way to give proper attribution and recognize the work of others.

Structure:

A well-organized CREDITS.md might look like:

# Credits

## Contributors

- **Jane Doe** - *Initial development* - [JaneDoe](https://github.com/janedoe)
- **John Smith** - *Feature implementation* - [JohnSmith](https://github.com/johnsmith)

## Third-Party Libraries

- [Library Name](https://library-url.com) - Brief description of its use in your package
- [Another Library](https://another-library.com) - How it enhances your package

## Resources

- Icons from [IconSource](https://icon-source.com)
- Documentation template inspired by [DocTemplate](https://doc-template.com)

Tips:

  • Be thorough in acknowledging all contributors and resources.
  • Include links to personal profiles or project pages when available.
  • Specify the role or contribution of each person or resource.
  • Update the credits file as new contributors join or additional resources are used.
  • Consider organizing by categories if the list becomes lengthy.

Note: While including LICENSE and CREDITS.md is optional, it's highly recommended, especially for packages that will be widely distributed. These files not only fulfill legal obligations but also demonstrate professionalism and respect for the broader development community.