diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..522ec6f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Welcome to jamo contributing guide + +Thank you for investing your time in contributing to our jamo project! Any contribution you make will be reflected on [README.md](https://github.com/ymw0407/jamo#contributors) ✨. + +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. + +## Got a Question or Problem? + +If you have any question or problem, start issue with [blank_issue](https://github.com/ymw0407/jamo/issues/new) or send mail to [maintainers](mailto:yunminwo1211@gmail.com). +Then our maintainers, collaborators and contributers will help you. + +## Submitting a issue! + +_Do your best to follow these guidelines when submitting bug-related issues or feature requests. Then we will be able to respond quickly with good feedback more easily._ + +### Did you find a bug? + +If you find a bug in the source code, you can help us by submitting an [Bug Report issue](https://github.com/ymw0407/jamo/issues?q=is%3Aopen+is%3Aissue+label%3Abug). Even better, you can submit a Pull Request with a fix. +
+ +### Do you want a new feature? + +You can request a new feature by submitting an [Feature Request issue](https://github.com/ymw0407/jamo/issues). +_If you have a framework that needs support, please post it on Framework Request Issue!_ +