Contribution Guide

This is a guide on how to contribute to Sky Follower Bridge.
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.

Fork the repository
Create a branch
Add or modify feature
Run e2e and unit test
Check the feature in your browser
Commit Changes
Push branch
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 https://github.com/kawamataryo/sky-follower-bridge.git

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

$ npm i

The dev command starts the development server.

$ npm 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.

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

Release

When the version file of changesets is merged into master, released to each store with a GitHub Actions job.

add version file

npx changeset add

git push

git add .changesets
git commit -m "🛠️  add changeets"
git push origin master

2.7 KiB Raw Blame History