developers getting started

Getting Started

Welcome to Floorp developer community! This page is for contributors. If you want to try Floorp, please download the latest version from here.

What skills do I need to contribute to Floorp?

You need to be able to use Git and GitHub & and be able to write code in JavaScript, HTML, and CSS.

• Git
• GitHub
• JavaScript
• HTML
• CSS

Floorp uses XHTML on the front end of the browser. If you are not familiar with XHTML, please refer to the following page.

• XHTML
• XUL

Build Floorp

Build from source code. You can build Floorp on Windows, macOS, and Linux. Please refer to the following page for details.

Before making a contribution, please read building instructions for your platform:

• on Windows

• on macOS

• on Linux

How do I contribute to Floorp?

It is too easy to contribute to Floorp. You can contribute to Floorp by doing the following:

1. Fork the Floorp repository on GitHub.

2. Clone your fork of the repository locally. At the command line:

   git clone https://github.com/<your GitHub username>/Floorp.git
   git submodule update --init --recursive
   echo 'ac_add_options --with-branding=browser/branding/official' >> mozconfig

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

4. When you're done making changes to Floorp, check that your changes pass the tests and lint checks:

    ./mach lint --fix ./path/to/changed/files

   ./mach lint checks missing license header notice, Fix JavaScript style issues.

5. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "[FB] <Component name here> | <What you did here>"
   git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.

   How to send a pull request is here.

7. Wait for the Floorp team to review and merge your changes.

I have questions about development. Where can I ask?

If you have any questions about development, please ask them GitHub Disscussions, Discord (Ablaze Community) or Reddit r/Floorp.