Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (23 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.69 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

  • .husky contains git hooks configurations.
  • components contains the generic components used inside the application.
  • constants contains the constant values and settings.
  • pages contains page components for next.js.
  • public contains static assets to be used in whole website (fonts, images, etc.).
  • styles contains the global styles for the website.
  • 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:

  • 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.

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.