Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 2.47 KB

Contributing

Feel free to contribute in any way you like, and if you feel comfortable doing so, follow our standard instructions below and learn how to do it.

Project structure

  • api contains all the external requests to our application
  • assets contains the system's multi-language files
  • components contains the generic components used inside the application
  • connectors contains the the logic to connect to web3 wallets
  • constants contains the constant values and settings
  • design-system contains the files that standardize the design system used in the app, from breakpoints to the color system
  • elements contains the atomic components used within the generic components
  • hooks contains generic React hooks
  • pages contains page components for next.js
  • server contains the server API logic
  • types contains application wise types and interfaces
  • utils contains generic utility functions used in the application
  • Views contains the view building blocks for each page.

Issue reports

A bug usually happens when something doesn't work as expected, and it can be caused by some code in the repository. Reports are important to help us overcome them.

Below are instructions on how to optimally report a bug:

In the Application

  • Feedback Button: in the header, there is a button on the left side of application logo (on mobile, open the menu on the right, and in the last position is the "Feedback" button). Fill out the Google Forms form and report what happened.

In the Repository

  • Try to reproduce the bug in the main branch: The bug may have already been passed in the latest version, always check before reporting the issue.
  • Check to see if the issue hasn't already been reported: It could be that your issue has already been reported by someone else, make sure it is not on the list.
  • Open a git issue: Explain what happened, and give as much detail as possible so we can try to reproduce the same situation.

A good bug report shouldn't leave others needing to chase you up for more.

Tests

To run the tests run the command below:

  yarn test

Commit

To commit, you must:

  • Certify if your code is valid to linters;
  • Use commit rules in Gitmoji Commitlint:
    • Starting with one of these emojis (Gitmoji);

Don't forget to setup your IDE with eslint and prettier.