Skip to content
This repository was archived by the owner on Dec 4, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (42 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

74 lines (42 loc) · 2.38 KB

Contributing

Thank you for your interest to contribute to Chakra Templates. You are awesome!

Setup the Project

  1. Fork this repository

  2. Clone your fork to your local machine

    git clone https://github.com/<your_github_username>/chakra-templates.git
cd chakra-templates

  3. Install all dependencies by running yarn install in your terminal

To fetch the current github stargazers count during development it is necessary to create a .env.development.local file with a GitHub access token inside.

Make sure the token permissions look like this

Demo

In other words ✅ in the repo checkbox and then click on Generate Token

GITHUB_TOKEN=YOUR_TOKEN_HERE

Development

Commands

yarn dev: run the Next.js dev command. Visit http://localhost:3000/ to see the local environment

yarn build: run the Next.js build command

yarn start: run the Next.js start command

yarn lint:ts: lint all the files regarding typescript errors

yarn test:watch: run jest in watch mode,

yarn test:ci: runt jest in CI mode

Adding a new Template

Adding a new template can be archived within 2 simple steps.

  1. Update the data in src/data/index.ts

    This is the main data source of the website. Find the right category or create a new one if necessary.

  2. Create the template file itself in src/pages/templates

    Attention! The file structure must match the data inside src/data/index.ts

Miscellaneous

Commit convention

Please follow the convention category(scope or module): message in your commit message while using one of the following categories:

feat / feature: changes that introduce new code or features

fix: changes that fix a bug (reference an issue if present)

refactor: any code related change that is not a fix, nor a feature

docs: changing existing or creating new documentation

chore: all changes to the repository that do not fit into any of the above categories