Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

99 lines (63 loc) · 2.59 KB
Raw

Contribution Guide

This is a guide on how to contribute to Chikamichi.
Contributions are welcome 🎉

Issues

The following Issue is accepted.

  • Questions about features
  • Report errors or problems
  • Propose additions or improvements to feature

Please click here to issue.

Pull Request

Pull requests are always welcome.

The following types of Pull Requests are accepted. For basic Pull Requests (especially minor ones), you may send a Pull Request without creating an Issue.

  • Bug Fixes
  • Add functionality
  • Performance Fixes
  • Typo Fixes

"How about this kind of fix/improvement?" If you have a question, please raise an Issue and discuss it with me.

How to send Pull Request

Please follow these steps to create a pull request.

  1. Fork the repository
  2. Create a branch
  3. Add or modify feature
  4. Run e2e and unit test
  5. Check the feature in your browser
  6. Commit Changes
  7. Push branch
  8. Create Pull Request

Also, when creating a pull request, please keep the following in mind

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.
  • Add tests! - If you add a feature, it would be great if you could write a test for it.
  • Keep the same style - eslint will automatically be ran before committing
  • Document any change in behavior - Make sure the README.md and any other relevant documentation are kept up-to-date.
  • Send coherent history - Make sure your commits message means something

How to set up a Local Development Environment

First, clone the forked repository locally.

$ git clone git@github.com:foo/chikamichi.git

Install dependent modules with pnpm. If you do not have pnpm, please install it beforehand.

$ pnpm i

The dev command starts the development server.

$ pnpm run dev

When the development server starts, the Extension build results are output to the extension.

You can use extensions in your browser by loading the contents of the extensions folder in Chrome Exteinsions.

image

image

When you modify the code, the change is automatically reflected.

How to run test

Chikamichi have e2e test and unit test.

Run unit test.

$ pnpm run test

Run e2e test.

$ pnpm run cypress:open

That's it. Happy coding 👍