diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..6efe9c2 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @tsutomi \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ae9cf3a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +We highly appreciate contributions to this project. We are open to any kind of contribution, including but not limited to: + +- Reporting a bug +- Requesting a feature +- Submitting a pull request +- Writing documentation +- Writing tests +- Providing feedback + +## Pull Requests + +When you want to contribute to the source code of the project, please follow these steps: + +1. Fork the repository +2. Create a new branch for your feature or bug fix +3. Write your code +4. Write tests for your code +5. Run the tests +6. Commit your changes +7. Push your changes to your fork +8. Create a pull request + +The requests will be reviewed and merged as soon as possible, but please be patient. We will get back to you as soon as we can. + +It might be possible that we ask you to make some changes to your pull request. We will do our best to help you with that. + +## Reporting a Bug + +If you find a bug in the project, please report it by creating a new issue. Please provide as much information as possible, including: + +- The version of the project you are using +- The steps to reproduce the bug +- The expected behavior +- The actual behavior +- Any other information that might be useful + +## License + +By contributing to this project, you agree that your contributions will be licensed under the [License](LICENSE) of this project. \ No newline at end of file