Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 2.14 KB
Raw

Contribution Guidelines

First, thanks for your interest! We appreciate your time.

Some background

This library is primarily maintained by the Mist team at the Ethereum Foundation. Mist was recently refactored into several projects; you can learn more about its constituent parts here:

  • ethereum-react-components (this repo) - a React component library
  • grid-ui - uses the component library to assemble Grid's user interface
  • grid - the desktop app wrapper for grid-ui
  • electron-app-manager - handles app updates

How can I contribute?

  • Answer/contribute to other user's open issues.
  • Report a bug by opening a GitHub issue.
  • Suggest an enhancement by opening a GitHub issue.
  • Contribute to documentation by opening a pull request.
  • Fix a bug or add a feature by opening a pull request.

Adding new features

Before spending the time on a new feature that isn't already requested in an issue, please open a new issue to suggest the enhancement. The Mist team will let you know whether the proposed feature fits into our broader vision.

Reporting bugs

Before filing, please search for related issues and contribute to existing discussions if appropriate. If no bug resembles yours, do your best to fill out the new issue template, including detailed steps to reproduce the issue.

Pull Requests

  • Please fill out the PR template! Your answers will help us review and merge your code more quickly.
  • Use your linter! If your editor isn't configured with eslint, run it in a terminal window with yarn lint:watch or npm run lint:watch.
  • Use conventional commits to help us evaluate semantic versioning needs, e.g. fix:, feat:, docs:, etc. commit prefixes.
  • Reference related issues when appropriate, e.g. "Closes #13" in a PR description.