Skip to content

Latest commit

 

History

History
102 lines (66 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

102 lines (66 loc) · 3.23 KB
Raw

Contributing Guide

Issue Reporting Guidelines

  • The issue list of this repo is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately.

  • Try to search for your issue, it may have already been answered or even fixed in the main branch.

  • Check if the issue is reproducible with the latest stable version of gh-changelogen. If you are using a pre-release, please indicate the specific version you are using.

  • It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled status: need more repro codes or info receives no further input from the issue author for more than 5 days, it will be closed.

  • For bugs that involves build setups, you can create a reproduction repository with steps in the README.

  • If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

Pull Request Guidelines

  • Checkout a topic branch from the main branch.

  • It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.

  • Make sure all script tasks passes. (see development setup)

  • If adding new feature:

    • Add accompanying test case.
    • Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.

  • If fixing a bug:

    • Provide detailed description of the bug in the PR.
    • Add appropriate test coverage if applicable.

Work Step Example

  • Fork the repository from gh-changelogen !
  • Create your topic branch from master: git branch my-new-topic origin/main
  • Add codes and pass tests !
  • Commit your changes: git commit -am 'Add some topic'
  • Push to the branch: git push origin my-new-topic
  • Submit a pull request to main branch of kazupon/textlint-rule-no-pair repository !

Development Setup

After cloning the repo, run:

npm install

Lint

lint checks for the following:

  • Prettier follows the format of this project
  • ESLint follows the rules of this project
npm run lint

Code Auto fix

The following commands fix those detected by Prettier and ESLint described earlier, using their respective fix functions.

npm run fix

Build

Builds source codes for publish to the lib folder.

You can write ES2015+ source codes in src/ folder.

npm run build

Tests

Run test code in test folder. Test textlint rule by textlint-tester:

npm test

Other script tasks

There are some other scripts available in the scripts section of the package.json file.