Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

Latest commit

 

History

History
45 lines (27 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.91 KB

How to contribute

Table of contents

Report a bug

Before submitting issue, please make sure the bug was not already reported. Then create a issue with this template.

Request a feature

Before submitting issue, please make sure the feature was not already requested. Then create a issue with this template.

Including real world usecases is very helpful and will make the process more effective.

Submit Pull Requests

We have a pre-commit hook that format source code with prettier, but sometimes it does not work well (especially if you are using GUI git client). In that case, please run format command (yarn format or npm run format, also fmt alias is available) to format all the source code before submitting a PR.

After you create a PR and all status checks passed, maintainer will check the PR soon.

Notes on issues and PRs

About issue/PR template

Do not remove any section! If you have nothing to write in the section, keep it blank.

"I feel my issue/PR is ignored!"

Once you submit an issue or PR, and nothing happened (add to projects, assign someone, reply, set labels, etc) for a week, you can mention to maintainer (@pocka) on the issue or email to [email protected].

As mainteiner also a human, they sometime forgets replying or triaging.

Stale issues and PRs

For the issues and PRs that have no activity for more than six months, we close the issue as stale. If you don't want the issue to be marked as stale, please participate in the discussion (but do not post a comment like just saying "+1").