diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..98385cf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +## 🙏 Welcome + +Any kind of contributions are valued. + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Getting Started](#getting-started) +- [Reporting Issues](#reporting-issues) +- [Pull Requests](#pull-requests) +- [Financial Contributions](#financial-contributions) + +## Code of Conduct + +By participating and contributing to this project, you agree to uphold our [Code of Conduct](./CODE_OF_CONDUCT.md). + +## Getting Started + +This project is under the organization called [Open Tech Foundation](https://github.com/Open-Tech-Foundation), please go through this and learn more about our core principles. + +- **Star the project**: If you really found this project useful, please star it to move forward. + +- **Share**: Please share this project to world by means of any medium. + +## Reporting Issues + +There is no strict guides to creating an issue in the Github issue tracker. + +- The issue can be a `Bug`, `Feature Request`, `Suggestions`, `Question`, etc. +- Please write clear & consice title. +- Please explain the nature of the issue. +- Describe how to reproduce if it is a bug. +- Explain what is the `expected` and the `actual` behaviour. + +The maintainers of the project will add appropriate labels to it. + +## Pull Requests + +We follow the standard `Fork and Clone` method for PRs. + +- Make code changes with performance in mind. +- Add `comments` to the code if necessary. +- Add `tests` if necessary. +- Update `docs` if needed. +- Add meaningful commit message & follow the [conventional commit format](https://conventionalcommits.org/) +- Include issue number in the commit message if your working on the existing issue like `fix: remove invalid #1337`. + +## Financial Contributions + +Supporting financialy is more important for the project's full-time maintainers. + +Please support us by donating. + +Currently we are accepting financial contributions via [Github sponsers](https://github.com/sponsors/Open-Tech-Foundation). + +Thanks for your valuable time.