Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
134 lines (91 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

134 lines (91 loc) · 3.99 KB
Raw

Starwind Contributing Guide

Welcome! I'm glad you're interested in contributing to the Starwind project. Before you start, please read the following guidelines.

About this repository

This repository is a monorepo.

Development

Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone to your local machine

git clone https://github.com/starwind-ui/starwind-ui.git

Navigate to the root folder

cd starwind-ui

Install dependencies

pnpm install

Create a new branch

git checkout -b my-new-branch

Run a workspace

You can use the pnpm --filter=[WORKSPACE] command to start the development process for a workspace. There are also a number of helper scripts in the root folder of the repository that you can use to run the development process for the different workspaces.

Examples

  1. Run the cli workspace
pnpm cli:dev
  1. Run the demo workspace
pnpm demo:dev

Running the CLI Locally

To run the CLI locally, you can follow the workflow below:

  1. Build and globally link the local Runtime, Astro adapter, React adapter, and CLI packages.
pnpm l
  1. Verify the linked CLI from another terminal.
starwind --help
  1. Unlink the local packages when you finish testing.
pnpm ul

Conventions

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features

  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)

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

  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies

  • test: all changes regarding tests (adding new tests or changing existing ones)

  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)

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

    e.g. feat(components): add new prop to the avatar component

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Steps to PR

  1. Fork of the starwind-ui repository and clone your fork

  2. Create a new branch out of the main branch. We follow the convention [type/scope]. For example fix/dropdown-hook or docs/menu-typo. type can be either docs, fix, feat, build, or any other conventional commit type. scope is just a short id that describes the scope of work.

  3. Make and commit your changes following the commit convention. Before opening a pull request, run pnpm check, pnpm test:all, and pnpm build. Run pnpm verify for the complete local CI-equivalent gate.

  4. Please note that you might have to run git fetch origin main:master (where origin will be your fork on GitHub).

  5. After making your changes, add a changeset by running pnpm changeset. This will open an interactive prompt where you can add a changeset.