Skip to content

Contributing

First off, thank you for considering contributing to Dipend! 🙏
Your help is extremely valuable and makes this project better for everyone.

This document outlines the guidelines and process for contributing.

  • Make sure to read through the documentation to understand the project.
  • Please check if there is an open issue for your intended contribution before opening a new one.
  • If you’re fixing a bug or suggesting a new feature, open an issue first to discuss your idea.

In order to protect the project’s long-term viability, all contributors must sign a CLA before their pull request can be merged.

  • You must read the Contributor License Agreement (CLA) at CLA.md.
  • You will be automatically prompted to sign the CLA when opening your first pull request.
  • If you have any issues with signing, please contact the maintainers.

We appreciate your understanding and support for open source! ❤️

  1. Fork the repository.
  2. Create a branch:
    Terminal window
    git checkout -b my-feature
  3. Make your changes:
    • Follow the project’s code style.
    • Write tests for new functionality.
    • Keep changes focused and minimal.
  4. Run tests and lint checks.
  5. Commit your changes:
    • Use clear and descriptive commit messages.
    • Example: docs: update typescript getting started
  6. Push your branch and open a pull request.

We are committed to creating a welcoming and respectful environment for all contributors.
Please read and follow our Code of Conduct.


Thank you again for contributing! 🎉
We are excited to have you as part of the Dipend community.