From 069e787622f98105969e16f95ec6c0da5f906bd2 Mon Sep 17 00:00:00 2001 From: Kevin Hermawan <84965338+kevinhermawan@users.noreply.github.com> Date: Fri, 27 Jan 2023 22:53:54 +0700 Subject: [PATCH] chore: adds `CONTRIBUTING.md` --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1c6ef04 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +Thanks for considering contributing to this open-source project! We welcome and appreciate any contributions, whether they are bug reports, feature requests, or code changes. + +## How to Contribute + +1. Fork the repository +2. Create a new branch for your contribution (e.g. `feat/new_feature` or `fix/bug_fix`) +3. Make your changes +4. Commit your changes and push to your fork +5. Create a pull request (PR) against the `main` branch of the main repository +6. Wait for your PR to be reviewed and merged + +### Issue Tracking + +We use GitHub issues to track bugs and feature requests. If you find a bug or have a feature request, please search the existing issues to see if it has already been reported. If not, please open a new issue. + +### Pull Request Guidelines + +- Make sure your code is well-documented and follows our existing code style +- Include test cases for any new functionality +- Make sure your code passes all existing tests and linting checks +- Reference any relevant issues in your PR description