Thank you for your interest in contributing to the AirSwap web app! We welcome contributions no matter their size.
While we use GitHub for issue tracking and project management, development is generally coordinated on the Discord server, which you should join to learn more about how and where to contribute.
First fork the airswap-web repository and then clone the project and install dependencies.
$ git clone https://github.com/<YOUR-GITHUB-USER>/airswap-web
$ cd airswap-web
$ yarn
When multiple people are working on the same body of code, it is important that everyone conforms to a style. We use a linter for code style, which you can use with a simple command.
$ yarn lint
We use styled-components for styling. When styling a component put your scss in a separate *.styles.tsx file in the component folder.
It’s a good idea to make PRs early on. A PR represents the start of a discussion, and doesn’t necessarily need to be the final, completed submission. Create a draft PR if you're looking for feedback but not ready for a final review. If the PR is in response to a GitHub issue, make sure to notate the issue as well.
GitHub’s documentation for working on PRs is available here.
Once your PR is ready, ensure all checks are passing and request a review.