Skip to content
This repository has been archived by the owner on Nov 5, 2023. It is now read-only.

Latest commit

 

History

History
61 lines (35 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

61 lines (35 loc) · 2.88 KB
Raw

Contribute to BLS Wallet

Thanks for taking the time to contribute to BLS Wallet!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

To get an overview of the project, see System Overview

To setup the repo for local use, see Local Development

Issues

Create a new issue

First search for an existing issue. If you find one, add any new insight, helpful context, or some reactions. Otherwise, you can open a new issue. Be sure to label it with anything relevant.

Solve an issue

Search for an existing issue that is unassigned and interests you. If this is your first time contributing, you may want to choose a good first issue.

Make Changes

  1. Fork the repo
  2. Checkout a new branch
  3. Make your changes

Quality Checks

  • You should add new/update test cases for new features or bug fixes to ensure that your changes work properly and will not be broken by other future changes.
  • Type checking and code linting should all pass.
  • For ambiguous Typescript typing, prefer unknown over any.

Commit your update

Commit your changes over one or more commits. It is recommended to format your commit messages as follows:

A short summary of what you did

A list or paragraph of more specific details

Pull Request

Create a pull request (PR) from your fork's branch to main, filling in the descriptions template including linking to the issue you are resolving. Feel free to open a draft PR while you are actively working.

Once ready, a BLS Wallet team member will review the PR.

  • When run, all Github Actions workflows should succeed.
  • All TODO/FIXME comments in code should be resolved, unless marked merge-ok with a description/issue link describing how they can be resolved in future work.
  • The author of a comment may mark it as resolved when they are satisfied with a requested change or answer to a question. You are not required to resolve all comments as some may provide good historical information.

Your PR is merged!

Thanks for your hard work! Accept our heartfelt gratitude and revel in your masterful coding and/or documentational skills.

Thanks

To github/docs CONTRIBUTING.md for being a great contribution template.