-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @tsutomi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |