Skip to content

Latest commit

聽

History

History
61 lines (40 loc) 路 2.21 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) 路 2.21 KB
Raw

Contributing

Frontend

Thank you for your interest in contributing to the Hop frontend!馃惏

Development

Before running anything, you'll need to install the dependencies:

pnpm --filter frontend... install

Running the interface locally

pnpm --filter frontend dev

Navigate to [http://localhost:3000].

Creating a production build

pnpm --filter frontend... build

Guidelines

The following points should help guide your development:

  • Security: the interface is safe to use
  • Reproducibility: anyone can build the interface
    • Avoid adding steps to the development/build processes
    • The build must be deterministic, i.e. a particular commit hash always produces the same build
  • Decentralization: anyone can run the interface
    • An Ethereum node should be the only critical dependency
    • All other external dependencies should only enhance the UX (graceful degradation)
  • Accessibility: anyone can use the interface
    • The interface should be responsive, small and also run well on low performance devices (majority of swaps on mobile!)

At the moment we're only considering bug fixes and small improvements. If you have a feature request, please open an issue first to discuss it.

Release process

Releases are cut automatically from the production branch according to the release workflow.

Fix pull requests should be merged whenever ready and tested.

Features should not be merged into develop until they are ready for users. When building larger features or collaborating with other developers, create a new branch from develop to track its development. When the feature is ready for review, create a new pull request from the feature branch into develop and request reviews from the appropriate UX reviewers (PMs or designers).

Finding a first issue

Start with issues with the label good first issue.