Please use a template to open new issue. Issues not conforming to the templates may be closed immediately.
If you're ready to tackle some open issues, we've collected some good first issues for you. And issues labeled like v1, v2, and vX...which indicate the release target has decided to implement.
-
Set up local copy, as described in development section below.
-
In your forked repository, make your changes in a new git branch:
git checkout -b my-fix-branch main
-
Create your patch, including appropriate test cases.
-
Run the
yarn lint --fix && yarn formatcommand. -
Run the full test suite, as described in test section below, and ensure that all tests pass.
-
Commit your changes using a descriptive commit message that follows our commit message conventions.
git commit --all
Note: the optional commit
-acommand line option will automatically "add" and "rm" edited files. -
Push your branch to GitHub:
git push origin my-fix-branch
-
In GitHub, send a pull request to
yamato-interface:main.
You will need Node.js and yarn.
- Fork the yamato-interface.
- Clone your fork of the repository and define an
upstreamremote pointing back to the repository that you forked in the first place.
# Clone your GitHub repository:
git clone [email protected]:<github username>/yamato-interface.git
# Go to the yamato-interface directory:
cd yamato-interface
# Add the main yamato-interface repository as an upstream remote to your repository:
git remote add upstream https://github.com/DeFiGeek-Community/yamato-interface.git- Prepare environment variables. Especially,
REACT_APP_INFURA_KEYis required. - Install dependencies and start.
- You can view it at
http://localhost:3000.
# Prepare environment variables.
cp .env.sample .env.local
# Install dependencies and start.
yarn && yarn startCommit messages should follow the commit message convention.
The repository uses Jest and Cypress.
Please see test section
yarn testPlease refer to TEST and cypress.
yarn cypress:open