Skip to content

Latest commit

 

History

History
71 lines (59 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

71 lines (59 loc) · 2.14 KB
Raw

💖 Contributing to the extension

Thank you for your interest in contributing to the extension! 🎉

📝 Table of Contents

🐛 Reporting Bugs

If you encounter any bugs while using the extension, please create an issue on this repository. Please make sure to include the following information in your issue:

  • The steps to reproduce the bug.
  • The expected behavior.
  • The actual behavior.
  • The version of the extension you are using.
  • The version of your browser.
  • The operating system you are using.

📝 Pull Requests

If you want to contribute to the project, please create a pull request. Please make sure to follow these steps:

  1. Fork the repository by clicking on the "Fork" button on this page.
  2. Clone your fork to your local machine.
git clone
  1. Create a new branch from the main branch with a descriptive name.
git checkout -b
  1. Make your changes and commit them with a descriptive commit message.
git commit -m
  1. Push your branch to your fork.
git push origin
  1. Create a pull request on this repository with a descriptive title and message.

🛠️ Development

Install all dependencies. This project uses yarn as the package manager. If you don't have yarn installed, you can install it by running the following command:

npm install -g yarn

Then, install all dependencies by running the following command:

yarn

We are using Vite as the build tool. along with crxjs. To run the extension in development mode, run the following command:

yarn dev

To build the extension, run the following command:

yarn build

We use Rome as the linter and formatter. To run the linter and formatter, run the following command:

yarn lint
yarn format

Check out CrxJS's documentation for more information on how to use it. And check out React's documentation for more information on how to use React.