Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (25 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.25 KB

Contributing to dTip

We welcome contributions to dTip! Below are the guidelines for contributing to the Smart Contracts parts of the project. You also can contribute to the Web Client.

General Guidelines

  • Fork the repository and create a new branch for each feature or bug fix.
  • Ensure your code follows the project's coding standards.
  • Write tests for any new functionality or bug fixes.
  • Commit with clear, descriptive messages.

Smart Contracts

  1. Development Setup

    • Ensure you have Foundry installed.
    • Run forge install to install dependencies.
    • For local development, run forge test to ensure everything is working.

  2. Creating Changes

    • Write clean and modular contracts.
    • Ensure tests are included for all changes in tests/.
    • Follow the best practices for security.

  3. Testing

    • Use Foundry's test framework (forge test) to ensure all tests pass.
    • Provide unit tests for every new contract or function.

Submitting Changes

  1. Push your changes to your fork.
  2. Open a pull request with a clear description of the changes.
  3. Ensure your pull request passes all tests before submitting.

Thank you for contributing to dTip!