keepassxc-browser/.github/CONTRIBUTING.md

Contributing to KeePassXC-Browser

The following is a set of guidelines for contributing to KeePassXC-Browser on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of contents

What should I know before I get started?

• Open Source Contribution Policy

How can I contribute?

• Feature requests
• Bug reports
• Discuss with the team
• Your first code contribution
• Using AI
• Pull requests
• Translations

Styleguides

• Git branch strategy
• Git commit messages
• Coding styleguide

What should I know before I get started?

Open Source Contribution Policy

Source: Version 0.3, 2015–11–18

Policy

We will accept contributions of good code that we can use from anyone.

What this means

This means exactly that. We don’t care about anything but your code. We don’t care about your race, religion, national origin, biological gender, perceived gender, sexual orientation, lifestyle, political viewpoint, or anything extraneous like that. We will neither reject your contribution nor grant it preferential treatment on any basis except the code itself. We do, however, reserve the right to limit your access to our community if you violate our Code of Conduct.

If Your Contribution Is Rejected

If we reject your contribution, it means only that we do not consider it suitable for our project in the form it was submitted. It is not personal. If you ask civilly, we will be happy to discuss it with you and help you understand why it was rejected, and if possible improve it so we can accept it.

How can I contribute?

Feature requests

We're always looking for suggestions to improve our application. If you have a suggestion to improve an existing feature, or would like to suggest a completely new feature for KeePassXC, please use the issue tracker on GitHub.

Bug reports

Our software isn't always perfect, but we strive to always improve our work. You may file bug reports in the issue tracker.

Before submitting a bug report, check if the problem has already been reported. Please refrain from opening a duplicate issue. If you want to add further information to an existing issue, simply add a comment on that issue.

Discuss with the team

As with feature requests, you can talk to the KeePassXC team about bugs, new features, other issues and pull requests on the dedicated issue tracker, on the Matrix development channel, or in the IRC channel on Libera.Chat (#keepassxc-dev on irc.libera.chat, or use a webchat link).

Your first code contribution

Unsure where to begin contributing to KeePassXC? You can start by looking through these beginner and help-wanted issues:

• Beginner issues – issues which should only require a few lines of code, and a test or two.
• 'Help wanted' issues – issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, looking at the number of comments on an issue can give a general idea of how much an impact a given change will have.

Using AI

Submissions written using generative AI (even partially) are not accepted.

Pull requests

Along with our desire to hear your feedback and suggestions, we're also interested in accepting direct assistance in the form of code.

All pull requests must comply with the above requirements and with the styleguides.

Translations

Translations are managed on Transifex which offers a web interface. Please join an existing language team or request a new one if there is none.

If you open a Pull Request with new strings that require translations, it is enough to include new strings to the _locales/en/messages.json file.

Architecture

Some basic information about the extension architecture is described in the Extension details wiki page.

Styleguides

Git branch strategy

The Branch Strategy is based on git-flow-lite.

• develop – points to the development of the next release, contains tested and reviewed code
• feature/[name] – points to a branch with a new feature, one which is candidate for merge into develop (subject to rebase)
• fix/[name] – points to a branch with a fix for a particular issue ID
• refactor/[name] - points to a branch with a refactored feature

Git commit messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to…" not "Moves cursor to…")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally
• If your pull request fixes an existing issue, add "Fixes #ISSUENUMBER" to your pull request description

Coding styleguide

The coding style of the project is applied using ESLint and Prettier tools. A thorough description of the coding style can be found in the .eslintrc and .prettierrc files, but the main conventions are presented here.

ESLint can be run manually by using the command npm run lint. Prettier formatting is not used by default because it can break some specific code styles, but can be enabled modifying the .prettierignore file.

Naming convention

lowerCamelCase

For names made of only one word, the first letter should be lowercase. For names made of multiple concatenated words, the first letter of the whole is lowercase, and the first letter of each subsequent word is capitalized. Applies to functions and Objects as well.

UpperCamelCase

For classes and enum-like Objects.

ALL_CAPS

For global/const variables and enum-like Object values.

Indention

• For JavaScript files (*.js): 4 spaces
• For HTML files (.ui): 2 spaces
• For JSON files (*.json): 2 spaces
• For TypeScript files (*.ts): 2 spaces

Global/const variables

const TIMEOUT_VALUE 2000;
const DEFAULT_VALUE = 'all';

Classes

class Icon {
    constructor(databaseState) {
        this.databaseState = databaseState;
        this.icon = null;
    }
}

Enum-like Objects

const ManualFill = {
    NONE: 0,
    PASSWORD: 1,
    BOTH: 2
};

Braces

if (condition) {
    doSomething();
} else {
    doSomethingElse();
}

const exampleFunction = async function() {
    doSomething();
};

Multiple conditions

if (condition1 === condition2
    || condition3 === condition4
    || condition5 === condition6) {
    doSomething();
}

if (['text1', 'text2', 'text3'].includes(inputText)) {
    doSomething();
}

Variables

Always use const and let to define a variable. Do not use var.