Open Source

How to Contribute

Flux is open source and community-driven. Whether it's a bug fix, new feature, or documentation improvement — your contributions are welcome.

Getting Started

Set up your environment

Get Flux running locally in under 2 minutes.

01

Fork & Clone

Fork this repository and clone your fork to your local machine:

Terminal
git clone https://github.com/<your-username>/Flux-Extension.git
cd Flux-Extension
02

Install Dependencies

Node.js 20+ is required for linting and development tooling:

Terminal
npm install
03

Create a Branch

Always create a feature branch for your changes:

Terminal
git checkout -b feat/your-feature-name
Workflow

Development workflow

Lint, load, and test — the essentials before opening a PR.

Lint Before Committing

The CI will reject PRs that fail linting. Always run lint before pushing:

Terminal
npm run lint          # check for issues
npm run lint:fix      # auto-fix what's possible

Load Extension Locally

Test your changes in each browser you want to support:

Chrome chrome://extensions/ → Developer mode → Load unpacked
Firefox about:debugging → This Firefox → Load Temporary Add-on
Edge edge://extensions/ → Developer mode → Load unpacked
Pull Request

Opening a PR

Push your branch and open a Pull Request against main.

Push & Open PR

Push your feature branch and open a PR against main.

Automated Checks

Your PR runs through two automated checks — both must pass before merging.

lint (GitHub Actions) Runs npm run lint via ESLint
CodeRabbit (AI Review) Automated code review with suggestions

Review & Merge

A maintainer will review and approve once all checks pass. Then you're in! 🎉

Branch Rules: The main branch is protected — all changes must come through a PR with at least 1 approval and passing status checks. Direct pushes to main are blocked.

Ideas

What can you contribute?

Here are some ways to get involved right away.

🐛

Bug Fixes

Found a broken conversion or a UI glitch? Fix it and submit a PR. Check the Issue Tracker for known bugs.

✨

New Features

Have an idea for a new currency, a UI improvement, or a new site integration? We'd love to hear it.

📝

Documentation

Improve the README, add inline code comments, or write guides to help other contributors onboard.

🧪

Testing

Test Flux on different browsers, operating systems, and websites. Report what breaks and what works.

Ready to make your first contribution?

Fork the repo, pick an issue, and start building. Every contribution matters.

Fork on GitHub