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.
Before You Start
Section titled “Before You Start”- 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.
Contributor License Agreement (CLA)
Section titled “Contributor License Agreement (CLA)”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! ❤️
How to Contribute
Section titled “How to Contribute”- Fork the repository.
- Create a branch:
Terminal window git checkout -b my-feature - Make your changes:
- Follow the project’s code style.
- Write tests for new functionality.
- Keep changes focused and minimal.
- Run tests and lint checks.
- Commit your changes:
- Use clear and descriptive commit messages.
- Example:
docs: update typescript getting started
- Push your branch and open a pull request.
Code of Conduct
Section titled “Code of Conduct”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.