Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 5.86 KB

CONTRIBUTING.md

File metadata and controls

107 lines (76 loc) · 5.86 KB
Raw

Contributing

Thank you for your interest in contributing to DeFi Desktop Wallet! Good places to start are this document and the official documentation. If you have any questions, feel free to ask on Discord.

Code of Conduct

All contributors are expected to follow our Code of Conduct.

Feature requests and bug reports

Feature requests and bug reports should be posted as Github issues. In an issue, please describe what you did, what you expected, and what happened instead.

If you think that you have identified an issue with Chain that might compromise its users' security, please do not open a public issue on GitHub. Instead, we ask you to refer to security policy.

Sending Pull requests

There are several ways to identify an area where you can contribute:

  • You can reach out by sending a message in the developer community communication channel, either with a specific contribution in mind or in general by saying "I want to help!".
  • Occasionally, some issues on Github may be labelled with help wanted or good first issue tags.

Discuss First

Before sending a feature pull request, it's always better to open a issue first to discuss whether it is desired and the design of the feature.

Editor Setup

We recommend using VS Code along with the ESLint extension.

Style Guide

The code and comments should follow Google TypeScript Style Guide. Many of the code style rules are captured by eslint.

Branch Model

We use the Fork and Pull model and GitFlow to work on this repository.

There are two main branches:

  • dev: This is the branch that is used to work on features and bug fixes.
  • master: This is the branch that is used to work on the official release.

Commit Convention

We use Conventional Commits for commit messages. Please read the guide through if you aren't familiar with it already.

Changelog

Changelogs are handled by maintainers, which will be batch updated before each release.

Multi-Language Content Management

Please refer to the Instructions on Multi-Language Content Management for any content updates.

Detailed Pull Request Steps

  • Fork the DeFi Desktop Wallet's repository under your Github account.
  • Clone your fork locally on your machine.
  • Post a comment in the issue to say that you are working on it, so that other people do not work on the same issue.
  • Create a local branch on your machine by git checkout -b branch_name from dev branch.
  • Commit your changes to your own fork -- see Conventional Commits for commit message guidelines.
  • Include tests that cover all non-trivial code.
  • Check you are working on the latest version on dev in DeFi Desktop Wallet's official repository. If not, please pull DeFi Desktop Wallet's official repository's dev (upstream) into your fork's dev branch, and rebase your committed changes or replay your stashed changes in your branch over the latest changes in the upstream version.
  • Run all tests locally and make sure they pass. yarn test
  • If your changes are of interest to other developers, please make corresponding changes in the official documentation and the changelog.
  • Push your changes to your fork's branch and open the pull request to DeFi Desktop Wallet's repository dev branch.
  • In the pull request, complete its checklist, add a clear description of the problem your changes solve, and add the following statement to confirm that your contribution is your own original work: "I hereby certify that my contribution is in accordance with the Developer Certificate of Origin (https://developercertificate.org/)."
  • The reviewer will either accept and merge your pull request, or leave comments requesting changes via the Github PR interface (you should then make changes by pushing directly to your existing PR branch).

Developer Certificate of Origin

All contributions to this project are subject to the terms of the Developer Certificate of Origin, available here and reproduced below:

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.