Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

68 lines (42 loc) · 2.64 KB

Contributing

Thank you for your interest in contributing to the AirSwap Member Dashboard app! We welcome contributions no matter their size.

Issues

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.

Key libraries

TODO: add this.

  • React-Query
  • TailwindCSS
  • Viem
  • Wagmi

Code Style

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

For code formatting we use prettier. This will be run after you commit your code but can also be run manually.

$ yarn prettier

Coding patterns

  • We extensively use hooks
    • It is common for a hook to return undefined when it is either disabled or is still fetching data.
  • We are happy to build components that are responsible for fetching their own state. For example a balance input that shows the wallet balance within it will always need a token balance, so it makes sense if it fetches that itself.

Styling

TODO:

  • Brief intro to tailwind
    • Theming
    • intellisense
  • Combining classes with twMerge
  • Tailwind best practices
  • Giving components className prop
  • tailwind resources

The tailwind prettier plugin automatically orders classes to ensure a consistent pattern.

Tanstack query

Translations (POEditor)

New translations should be added manually to public/locales/en/translation.json first. After your PR is merged an admin will add the new translations in POEditor. Everything in public/locales will eventually be overwritten by POEditor. If you want to help with translating please let us know.

Pull Requests (PRs)

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.

Usually your PR is connected to a ticket number, so please put the ticket number (for example 101) in the description of your PR like so:

Fixes #101

GitHub’s documentation for working on PRs is available here.

Once your PR is ready, ensure all checks are passing and request a review.