Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 1.51 KB

Contributing

I would love for your contributions, here are the guidelines I would like you to follow.

Guidelines

Commit Messages

Just suit to Conventional Commits with these enums:

  • feat
  • docs
  • refactor
  • style
  • chore
  • build
  • fix
  • revert
  • ui: update of ui design

then commit

$ git commit -m 'fix: my fix'

Setup the Project

first of all, fork this repository from github then clone your forked repository.

$ git clone https://github.com/<your_github_username>/website
$ cd website

Create a branch for your contribute or use main branch

$ git branch -m 'my-fix-name'

Your repository setup ready, let's setup enviroment.

I'm using pnpm in this project you can see pnpm-lock.yaml. install pnpm or just use npm (slowest install)

$ npm install -g pnpm

Install dependencies and start app in development.

$ pnpm install
$ pnpm dev

Now you are ready to development make your code update.

Pull Request

You don't need to suit a Pull request template just add a description.

$ git add <my-changed-files>
$ git commit -m '<type>: <description>'
$ git push origin <your-branch>

Now go your forked repository in github.
Open a pull request from your repository then wait me!