Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 3.26 KB
Raw

Contributing to Casper Wallet

The following is a set of rules and guidelines for contributing to this repo. Please feel free to propose changes to this document in a pull request.

Submitting issues

  • If you have questions about how to use Casper Wallet, please first check the User Guides and FAQ on the Casper Wallet website.
  • And then join our community on Telegram where you can get help and stay up to date about Casper Wallet.

Guidelines

  • Please search the existing issues first, it's likely that your issue was already reported or even fixed.
    • Go to the main page of the repository, click "issues" and type any word in the top search/command bar.
    • You can also filter by appending e. g. "state:open" to the search string.
    • More info on search syntax within GitHub

Contributing code

All contributions to this repository are considered to be licensed under Apache License 2.0.

Development setup

  • Node.js 22 and npm 10+ are required (see .nvmrc; run nvm use if you use nvm).
  • Install dependencies with npm run setup — not plain npm install. This repo disables npm lifecycle scripts (ignore-scripts=true in .npmrc) as a supply-chain safeguard, so a plain install runs no dependency install scripts and does not set up the git hooks. npm run setup performs the full install: npm ci, the approved install scripts via @lavamoat/allow-scripts, and the git hooks.
  • See the README for build, watch and test commands.

Workflow for bug fixes

  • Check open issues and unmerged pull requests to make sure the topic is not already covered elsewhere
  • Fork the repository
  • Do your changes on your fork
  • Make sure to add or update relevant test cases
  • Create a pull request, with a suitable title and description, referring to the related issue

Before opening a pull request

  • Run npm run ci-check locally — it runs the same checks as CI (Prettier, ESLint, TypeScript, knip and unit tests with coverage)
  • Make sure the pull request title follows the semantic-release commit message conventions

Sign your work

We use the Developer Certificate of Origin (DCO) as a additional safeguard for the Casper Wallet project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license. Please read developer-certificate-of-origin. If you can certify it, then just add a line to every git commit message:

  Signed-off-by: Random J Developer <random@developer.example.org>

Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s. You can also use git aliases like git config --global alias.ci 'commit -s'. Now you can commit with git ci and the commit will be signed.