Skip to content

Latest commit

 

History

History
88 lines (52 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

88 lines (52 loc) · 3.18 KB
Raw

Conflux Contributing Guide

Hi! We are really excited that you are interested in contributing to Conflux. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Issue Reporting Guidelines

  • Please check the existing issues and the Conflux Bounty Site to avoid submitting duplicate issues.

Pull Request Guidelines

  • The master branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master branch. Submit to dev branch instead.

  • Checkout a topic branch from the relevant branch, e.g. dev, and merge back against that branch.

  • Work in the src folder and DO NOT checkin build directory into commits.

  • It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.

  • Make sure yarn test and yarn lint passes. (see development setup)

  • If adding a new feature:

    • Add accompanying test case.
    • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue and have it approved before working on it.

  • If fixing bug:

    • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899).
    • Provide a detailed description of the bug in the PR. Live demo preferred.
    • Add appropriate test coverage if applicable.

Development Setup

You will need Node.js version 8+, and yarn.

After cloning the repo, run:

$ yarn # install the dependencies of the project

Please use yarn instead of npm.

Commonly used yarn scripts

# serve watch and auto re-build the site
$ yarn start

# watch and auto re-run unit tests
$ yarn test:watch

# build the site
$ yarn build

There are some other scripts available in the scripts section of the package.json file.

The default test script will do the following: lint with ESLint -> unit tests with coverage. Please make sure to have this pass successfully before submitting a PR. Although the same tests will be run against your PR on the CI server, it is better to have it working locally.

Project Structure

  • build: contains built files for deploy. Note this directory shouldn't be checked into version control.

  • public: contains static resource files, these files won't go through webpack.

  • src: contains the source code. The codebase is written in TypeScript.

    • components: contains common ui components.

    • containers: contains pages.

    • locales: contains i18n translations templates.

Project technologies

Scan uses React, Styled-components to build the frontend.

Credits

Thanks to all the people who have already contributed to Conflux!