Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

101 lines (63 loc) · 4.51 KB
Raw

Building Our Markets

👏🏽 Thank you for your interest in contributing to TAD3. 🤝🏼 We appreciate your efforts to help improve our backend protocol layer. Please review the following guidelines to ensure a smooth and effective collaboration.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. Provide as much detail as possible, including:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual results
  • Any relevant logs, screenshots, or error messages

Feature Requests

We welcome suggestions for new features! To request a feature, please open an issue on GitHub and include:

  • A clear and descriptive title
  • A detailed description of the feature and its benefits
  • Any relevant use cases or examples

Submitting Changes

  1. Fork the Repository: Create a fork of this repository on GitHub.

  2. Clone the Repository: Open GitHub Desktop and clone the forked repository to your local machine.

    • In GitHub Desktop, go to File > Clone Repository.
    • Select the forked repository from the list and click Clone.

  3. Create a Branch: Create a new branch from main for your changes.

    • In GitHub Desktop, click Current Branch and select New Branch.
    • Name your branch feature/your-feature-name and click Create Branch.

  4. Make Changes: Implement your changes in the new branch.

    • Use your preferred code editor to make the necessary changes to the files.

  5. Commit Changes: Commit your changes with a clear and concise commit message.

    • In GitHub Desktop, you will see the changes you made under the Changes tab.
    • Write a commit message describing your changes, then click Commit to feature/your-feature-name.

  6. Push Changes: Push your changes to your fork on GitHub.

    • Click Push origin in GitHub Desktop to push your committed changes to the forked repository on GitHub.

  7. Open a Pull Request: Open a pull request (PR) on the original repository.

    • Go to the original repository on GitHub.
    • Click New Pull Request.
    • Select the branch with your changes and click Create Pull Request.
    • Provide a detailed description of your changes and any relevant information for the reviewers.

Code Standards

  • Write clear, concise, and considerate code.
  • Use camel case for variable and function names.
  • Use macro case for compiled constant variables.
  • Use two spaces for indentation to maintain consistency.
  • Ensure that your code is properly formatted and linted.
  • Choose descriptive function names that clearly indicate their purpose.
  • Strive to subscribe to clean code practices to maintain high code quality.

License

By contributing to TAD3, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0. This means:

  • Your contributions are free from attribution rights or royalties.
  • You are not entitled to direct monetary compensation for your contributions.

Financial Support

While direct monetary compensation is not provided, we encourage contributors to enable Sponsors on their GitHub profile. Continued development and significant contributions may attract financial support from the community.

Documentation

  • Ensure that any new features or changes are properly documented.
  • Update existing documentation as needed to reflect your changes.

Thank you for your contributions! Together, we can build a better platform for securities trading, issuance, and settlement.

If you have any questions or would like to discuss proposed upgrades, feel free to reach out on our community forms.