Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 5.15 KB

contributing.md

File metadata and controls

72 lines (46 loc) · 5.15 KB
Raw

Welcome to Anki xiehanzi docs contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on Anki xiehanzi ✨.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README or visit webpage Anki xiehanzi. Here are some resources to help you get started with open source contributions:

Getting started

The project contains three parts

  1. HSK tsv file which contains words and meaning of Chinese characters with pinyin and zhuyin. This is available as submodule in this project.
  2. The Anki xiehanzi deck which can be imported into Anki. Download decks from here.
  3. The web page which can be used as documentation as well as deck generation tool. The docs page created using docusaurus.io. View webpage [https://krmanik.github.io/Anki-xiehanzi]

Issues

Create a new issue

If you spot a problem with the decks, wrong meaning, pinyin or zhuyin, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

The PR for fix of issues related to HSK word lists can be submitted here.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

  1. Install Git

  2. Fork the repository.

  1. Install or update to Node.js v16. For more information, see the development guide.

  2. Create a working branch and start with your changes!

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the Anki xiehanzi.