ButterflyEffect/uniswap-interface-uncensored
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
318252b6a9
uniswap-interface-uncensored/CONTRIBUTING.md
Moody Salem 5f13f7824a
chore: update the contribution guidelines (#1987) 
* chore: update the contribution guidelines

* move

* note about non-deterministic steps

* little bit of separation

* language nits, add accessibility

* add reasoning
2021-07-07 19:48:03 -05:00

2.8 KiB
Raw Blame History

Contributing

Thank you for your interest in contributing to the Uniswap interface! 🦄

Development

Running the interface locally

  1. yarn install
  2. yarn start

Creating a production build

  1. yarn install
  2. yarn build

Engineering standards

Code merged into the main branch of this repository should adhere to high standards of correctness and maintainability. Use your best judgment when applying these standards. If code is in the critical path, will be frequently visited, or makes large architectural changes, consider following all the standards.

  • Have at least one engineer approve of large code refactorings
  • At least manually test small code changes, prefer automated tests
  • Thoroughly unit test when code is not obviously correct
  • Add integration tests for new pages or flows
  • Verify that all CI checks pass before merging
  • Have at least one product manager or designer approve of significant UX changes

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 run well on low performance devices (majority of swaps on mobile!)

Finding a first issue

Start with issues with the label good first issue.

Translations

Help Uniswap reach a global audience!

Uniswap uses Crowdin for managing translations. Whenever a new string is added to the project, it gets uploaded to Crowdin for translation by this workflow.

Every hour, translations are synced from Crowdin to the repository in this other workflow.

You can contribute by joining Crowdin to proofread existing translations here

Or, ask to join us as a translator in the Discord!