Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (52 loc) · 4.5 KB

CONTRIBUTING.md

File metadata and controls

87 lines (52 loc) · 4.5 KB

Contributing to TradeNotes

Thank you for your interest in contributing to TradeNotes! This document outlines the guidelines and legal terms that govern contributions to this project.

1. How to Contribute

We welcome contributions in the following forms:

  • Content contributions: Corrections, additions, or improvements to the Markdown documentation (e.g., tradenotes/ and other .md files)
  • Code contributions: Bug fixes, new scripts, or improvements to the Python code under code/
  • Issue reports: Filing well-documented issues for errors, inaccuracies, or suggestions
  • Pull requests: Submitting changes via pull requests for review and merging

Contribution Process

  1. Fork this repository
  2. Create a feature branch (git checkout -b feature/your-contribution)
  3. Make your changes and commit with clear, descriptive messages
  4. Submit a pull request describing the purpose and scope of your changes
  5. Await review and address any feedback

2. License Agreement for Contributions

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0). By submitting a contribution, you agree to the following terms:

2.1 All Contributions — CC BY-NC-SA 4.0

All contributions to this repository — including but not limited to Markdown files in tradenotes/, Python code under code/, README.md, and any other present or future files — shall be licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0).

By submitting any content, you:

  • Grant anyone the right to copy, distribute, and adapt your contributions for non-commercial purposes, provided that appropriate credit is given and derivative works are distributed under the same license;
  • Confirm that you have the right to license the content under CC BY-NC-SA 4.0 and agree to do so;
  • Agree that your contributions will be subject to the same license as the existing content in this repository.

2.1.1 Commercial License Grant to Project Maintainers

In addition, you agree to grant the project maintainers an additional, worldwide, royalty-free, non-exclusive, irrevocable license to use your contributed content for commercial purposes. This commercial license grant applies solely to the project maintainers and does not affect the rights of other users under CC BY-NC-SA 4.0.

Rationale: The content in this project is licensed under CC BY-NC-SA 4.0, ensuring that knowledge can be freely shared and disseminated while protecting the content from unauthorized commercial use by others. The project maintainers retain commercial usage rights to support the continued development and quality improvement of the project.

3. Contributor Representations

By submitting a contribution to this repository, you represent and warrant that:

  1. Originality: Your contribution is your original work, or you have sufficient rights to submit it under the CC BY-NC-SA 4.0 license
  2. No infringement: Your contribution does not infringe upon the intellectual property rights, privacy rights, or any other rights of any third party
  3. No confidential information: Your contribution does not contain any confidential or proprietary information belonging to any third party
  4. Authority: You have the legal capacity and authority to grant the rights described in this document
  5. Awareness: You have read and understood the license terms applicable to your contribution

4. Scope of CC BY-NC-SA License

The CC BY-NC-SA 4.0 license applies to all content in this repository, including:

  • Markdown documentation (.md files)
  • Python source code (.py files under code/)
  • Configuration and metadata files

It does not apply to:

  • Any trademarks, logos, or brand identifiers associated with the project
  • Third-party content referenced or linked within the documentation, which may be subject to separate license terms

5. No Obligation to Accept

The project maintainers reserve the right to accept or reject any contribution at their sole discretion. Submitting a contribution does not guarantee its inclusion in the repository.

6. Questions

If you have any questions about these contribution terms, please open an issue in the repository for discussion before submitting your contribution.

By contributing to this project, you acknowledge that you have read, understood, and agree to be bound by the terms of this document.