Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 2.46 KB

Contributing

Thank you for your interest in this project! Please contribute according to the following guidelines:

We usually communicate in Japanese for issues, pull requests, etc., but of course we welcome contributions in English.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Development environment setup

To set up a development environment, please follow these steps:

  1. Clone the repo

    git clone https://github.com/[ORG NAME]/[REPO NAME]

  2. [TODO]

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? Take a look at [GitHub Discussions](https://github.com/[ORG NAME]/[REPO NAME]/discussions) to see if it's already being discussed. You can help us by [submitting an issue on GitHub](https://github.com/[ORG NAME]/[REPO NAME]/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/[ORG NAME]/[REPO NAME]/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed [Pull Requests](https://github.com/[ORG NAME]/[REPO NAME]/pulls) that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git switch -c feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature')
  5. Push to the branch (git push origin feat/amazing_feature)
  6. [Open a Pull Request](https://github.com/[ORG NAME]/[REPO NAME]/compare?expand=1)