CONTRIBUTION.md

⭐ Contribution guide for new developers

We welcome and appreciate new contributions.

Testnet/testing-accounts for development use Alby testnet

We have setup some testnet nodes, which can be used for your development. If this is not reachable please let us know.

• Test-setup for different connectors (i.e. LND)
• Thunderhub for testing nodes (PW: getalby) Currently only lists LND nodes
• LNDhub.go API Swagger

After installing the wallet in the browser and setting the username and password, the page will jump to the page for selecting the lightning network wallet.

Select the LND Testnet accounts account LND-1 in the document Test-setup.

Copy the content of Address to the REST API host and port pasted into the wallet

Copy the contents of Admin Macaroon and paste it into the Macaroon (HEX format) in the wallet

Click Continue to create an account

Creating a PR

When creating a PR please take this points as a reminder:

• If there's not yet an issue for your PR please first create an issue with a proposal what you would like to do. This allows us to give feedback and helps you no wasting time and motivation
• Think in iterations (babysteps)
  You can always start a PR and if you feel like adding on more things to it, better branch off and create a new i.e. draft-PR
• Newly added components should have a unit-test
• If you work on a more complex PR please join our community chat (Invite link at https://bitcoin.design/) to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work. It's often faster and nicer to chat or call about questions than to do ping-pong comments in PRs

Code format & preferences

• ESLint for code linting
• Prettier for code (and more) formatting
• We prefer Axios over fetch

Code Editors

VS Code

For better support we recommend these extensions:

• vscode-eslint
• prettier-vscode
• vscode-tailwindcss
• vscode-html-css

Branch names

Please prefix your branch names with feat/, fix/, chore/, refactor/, docs/ based on the intent of the branch or issue being addressed (see commit message format below).

Commit message format

Alby enforces Conventional Commits Specification

A specification for adding human and machine-readable meaning to commit messages

Translations

Alby uses Weblate to manage translations for different locales. If you'd like to contribute, you can add translations here.

Rules for developers adding new i18n translation strings:

[Not to be confused with language translations]

We categorize strings into:

1. Translations
   Here we again divide strings as per screens (Welcome, Home...)
2. Common
   All the common words and actions (Confirm, Delete, Edit...)
3. Components
   The i18n strings which exist within the components (SitePreferences, QRCodeScanner, PublisherCard...)

Use underscores instead of camelCase

✅ Correct

"pay_now": "Pay Now"

❌ Wrong

"payNow": "Pay Now"

To avoid confusion, we prefer indentation over underscores, i.e.

✅ Correct

{
  "blue": {
    "label": "Blue"
  }
}

❌ Wrong

{
  "blue_label": "Blue"
}

Only indent strings when it is an input or has different attributes:

✅ Correct

{
  "edit": {
    "title": "Edit Account",
    "label": "Name",
    "screen_reader": "Edit account name"
  }
}

❌ Wrong

{
  "edit": {
    "title": "Edit Account"
  }
}

Correct way for this would be:

{
  "edit": "Edit Account"
}

Use title for heading tags and label for label tags

When the content is copy-text and you wish to divide it in parts, you can use numbers:

{
  "enable": {
    "request1": "Request approval for transactions",
    "request2": "Request invoices and lightning information"
  }
}

For button text, you can use common translations:

{
  "common": {}
}

You can add a new string if you don't find the suitable text in common. In that case, indent them within "actions":

{
  "actions": {
    "add_account": "Add account"
  }
}

Usually, we prefer single words in common, phrases like "Get Started", "Enable Now" can be indented in the above way.

Similarly, the error messages go within "errors":

{
  "errors": {
    "enter_password": "Please enter a new unlock password.",
    "confirm_password": "Please confirm your password.",
    "mismatched_password": "Passwords don't match."
  }
}