Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 2.73 KB
Raw

Contributing

Welcome to the contributing guide of this project. This guide will help you to contribute to this project.

Table of Contents

Development Notes

Although this project is a valid Koishi Plugin, it is different from other plugins.

The repository of this project only contains the source code for the plugin. The sentence bundle is not included in this repository. Instead, we use a GitHub Actions to sync the sentence bundle from hitokoto-osc/sentences. Thus, the version in package.json file is set to a dummy 0.0.0 version, then it would be updated by the GitHub Actions to the latest version of the sentence bundle.

What Can I Contribute?

It is always welcome to contribute to this project. You could contribute by:

Reporting Issues

If you find any issues, please report them to GitHub Issues. Please make sure to include the following information:

  • The version of this plugin you are using.
  • The version of Koishi you are using.
  • The version of Koishi Desktop / Node.js you are using.
  • The steps to reproduce the issue.
  • The expected behavior.
  • The actual behavior.

Submitting Pull Requests

If you want to contribute code to this project, please follow these steps:

  • Fork this repository.
  • Create a new branch from the master branch.
  • Make your changes.
  • Commit your changes.
  • Push your changes to your fork.
  • Create a pull request to the master branch of this repository.

Improving Documentation

If you want to improve the documentation, please follow these steps:

  • Follow the steps of Submitting Pull Requests.
  • Make your changes to the README.md file.
  • Commit your changes.
  • Create a pull request to the master branch of this repository.

Donating

ko-fi

If you want to donate to this project, please buy me a coffee !

Click the button above to donate via Ko-fi or Afdian (爱发电 in Chinese).