Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

68 lines (40 loc) · 3.57 KB

Contributing to Tangle

First off, thank you for considering contributing to Tangle! We're excited to have you here. This project is open-source, and we value every contribution, from bug reports to new features.

This document guides you through the process.

Quick Links:

  • GOVERNANCE.md Project Governance (How we make decisions)
  • SECURITY.md How to report vulnerabilities
  • Issue Tracker

📜 How to Contribute

We welcome contributions of all kinds! Here are a few ways you can help:

  • 🐛 Report Bugs: If you find a bug, please open an issue. Include as much detail as possible, like your environment, steps to reproduce, and the expected outcome.
  • ✨ Request Features: Have an idea? Open a feature request. We'd love to hear it.
  • 📝 Improve Documentation: If you see typos or areas where docs could be clearer, please submit a Pull Request!
  • 🧑‍💻 Write Code: Help us fix bugs or build new features.

🧑‍💻 Your First Code Contribution

Ready to submit your code? Here's the workflow we follow for external contributors.

1. Set Up Your Environment

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine:
  3. Create a new branch for your changes:

2. Make Your Changes

Write your code, write your tests, and make sure all existing tests pass.

3. Contributor License Agreement

We require that all contributions adhere to the Developer Certificate of Origin (DCO) https://developercertificate.org and the Apache 2.0 License https://opensource.org/license/apache-2-0. By submitting a Pull Request, you are certifying that you agree to these terms.

This ensures that:

  1. You have the right to submit this code.
  2. Your contribution will be licensed under the project's Apache License 2.0.

This is the full text of the DCO:

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

4. Submit a Pull Request

  1. Push your branch to GitHub.
  2. Go to the Tangle repository on GitHub and open a Pull Request (PR).
  3. In your PR description, explain what you changed and why. If your PR fixes an open issue, link to it using Closes #123.
  4. A Maintainer will be assigned to review your PR. They may ask for changes.
  5. Once your PR is approved and all CI checks pass, a Maintainer will merge it into the main branch.

That's it! We're incredibly grateful for your contribution.