Standards and Conventions

[jayantasamaddar]

About

The following standards and conventions must be met when contributing to this repository. Check Contributing Guidelines #4 for more.

---

Folder Structure

The folder structure looks like this:

|-- apps
|   `-- react-toolbelt-website
|      
|-- config
|   |-- jest
|   `-- scripts
`-- src
    |-- react-toolbelt-hooks
    |   `-- src
    |       |-- hooks
    |       |   |-- useChange
    |       |   |-- useClick
    |       |   |-- useHover
    |       |   |-- useKey
    |       |   |-- useResize
    |       |   `-- useScroll
    |       `-- types
    `-- react-toolbelt-utils
        |-- src
        |   |-- types
        |   `-- utils
        |       `-- isValidChildren
        `-- tests

• The apps folder exists to hold the website and other non-package applications.
• The src folder exists to hold the packages.

---

Naming Convention

• App and package folder names are prefixed with react-toolbelt-. E.g. react-toolbelt-hooks inside the src folder or react-toolbelt-website in the apps folder.
• The published packages have the name @react-toolbelt/{package-name}. E.g. @react-toolbelt/hooks.

---

Other Conventions

• When contributing a completely new feature, ensure to provide the new README.md following the Standards and Conventions mentioned above. This only helps us understand the feature better but is also read by the Documentation generator when generating the website, provided the standards and conventions are followed.

---