Skip to content
This repository has been archived by the owner on Aug 14, 2023. It is now read-only.

Latest commit

 

History

History
30 lines (19 loc) · 993 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 993 Bytes

How to contribute

We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or just correct a typo, please feel free to do so, as long as you follow our Code of Conduct.

If you're thinking of adding a big new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the project (and potentially save yourself some time!).

Getting Started

To start working on the codebase, first fork the repo, then clone it:

git clone [email protected]:your-username/starter-theme.git

Note: replace "your-username" with your GitHub handle

Install all package dependencies and link local packages:

yarn install

Write some features!

Documentation

If your change affects how people use the project (i.e. adding or removing functionality, changing the return value of a function, etc), please ensure the documentation is also updated to reflect this.