Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

75 lines (48 loc) · 2.93 KB
Raw

Contributing to @use-funnel libraries

Welcome contribution from everyone
All communications in this repository will be by English.

Every contributor to @use-funnel libraries should adhere to our Code of Conduct. Please read it to understand what actions will and will not be tolerated.

Contributing as issue

1. Search for duplicates

Search the existing issues before logging a new one.

2. Have a question?

The issue tracker is for issues, in other words, bugs and suggestions. If you have a question, please use GitHub Discussions, your favorite search engine, or other resources.

3. Found a bug?

When logging a bug, please be sure to include the following:

  • What version of TypeScript you're using (run tsc --v)
  • If at all possible, an isolated way to reproduce the behavior
  • The behavior you expect to see, and the actual behavior

4. Feature suggestion?

We also accept suggestions in the issue tracker.

In general, things we find useful when reviewing suggestions are:

  • A description of the problem you're trying to solve
  • An overview of the suggested solution

Contributing as code

Prerequisites

  1. Choose an issue about bug or feature you want to work on
  2. Fork this repository.
  3. Clone the repository 
    git clone [email protected]:{username}/use-funnel.git
  4. Please use the correct node version. You can use the version declared in .nvmrc. We strongly recommend nvm to control local machine's node version easily. also We recommend nvm's deeper shell integration too.
  5. Install packages. We use [email protected]. Install pnpm with corepack please if you can. We recommend using corepack for pnpm to automatically use the version declared in the packageManager field of package.json. 
    corepack enable && corepack prepare
pnpm install

Add a new router package

pnpm add:router --name your-router-name

Pull Requests

Opening a pull request

All commit message and title of your Pull Request should match the following format:

<type>[optional package scope]: <description>

[optional body]

[optional footer(s)]

We adhere Conventional Commits. We check your commits on pre-commit(git-hook) by husky with our rules. please follow it.

Several predefined GitHub Workflows will check qualities. If you fail our checks, please check the error message and update the Pull Request.