Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 3.05 KB

Contributing to @vnphanquang/githooks

Thank you for stopping by. @vnphanquang/githooks welcomes and appreciates your contribution.

Issues

Important

Before opening a new issue, first search for existing issues to avoid duplications. When you start working on an issue, make sure you are asked to be assigned to it.

Bug Report

Please include as much details as possible:

  • steps to reproduce,
  • screenshots.

Feature Request

If you have an idea and don't know where to start yet, consider opening a discussion first. If you have a PR ready as your proposed implementation, you can create an issue and a PR that references it.

Development

Prerequisites

Tool Version
Deno ^2.0.0

Code standard

Important

Rules are to be broken. There will always be exceptions. The following guidelines are not set in stone, but rather a set of recommendations to help us work together more effectively.

What is a Good Commit / Pull Request?

A commit should:

  1. have a descriptive message that hints at what the commit is about, exceptionally helpful for other contributors and reviewers.
  2. encapsulate a complete change, i.e a single feature, bug fix, or refactor that can make sense on its own.
  3. ideally capture a working state of the application / site. If not, it should be marked as [WIP] in its commit message.
  4. span a limited scope and has minimal footprint. If a commit does too much or has changes to many files, it is an indicator that the changes may be broken down into smaller commits.

Similarly, each pull request (PR) should work towards one issue or self-contained goal. If your PR contains a single commit, merge rebase (fast-forward). If there are multiple commits and you want to keep the merge history, prefer merge commit over squash, unless there are dirty commits in the branch.

Commit Message Guidelines

We follow the Conventional Commits guidelines for writing git commit message. Please familiarize yourself with the guidelines and be consistent.

[feat | fix | chore](scope): "[message beginning with a verb: add | change | remove]"

Code Style Enforcement

The project uses Deno builtin support for code linting and formatting. Make sure to install necessary plugins or integrations in your code editor.

githooks & lint-staged is setup to run format and lint checks as a pre-commit git hook. To bypass hook (not recommended, for admin only), run git commit with the --no-verify flag.