Skip to content

Files

Latest commit

 

History

History
51 lines (39 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

51 lines (39 loc) · 2.97 KB

Contributing to Casper Wallet Core

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.

  • If you have questions on how to use Casper Wallet Core in your own projects, please check the instructions on the README first.

  • If you want to build Casper Wallet Core as a dependancy for Casper Wallet extension or Casper Wallet mobile, please head over to their repective repositories. You do not need to build CW Core separately as it's already been integrated into the build processes of those two apps.

  • If you have further questions, you can ask them on:

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 to Casper Wallet Core

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

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

Sign your work

We use the Developer Certificate of Origin (DCO) as a additional safeguard for the Casper Wallet Core 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.