mirror of https://github.com/teableio/teable synced 2024-11-21 06:42:28 +00:00

* chore: update config for prerelease

* feat: add release packages ci

* chore: release ci scripts

* ci(release): test

* ci: release ci steps fixed

* fix: useless build

* chore: gen prisma client before build db-main-prisma

* ci: test

* ci: the correct npm token location to use for the publish action

* chore: packages access public setting

* chore: remove changesets

* chore: alternative esm

2024-03-20 19:03:52 +08:00

4.0 KiB

Raw Permalink Blame History

Contributing

The base branch is main.

Workflow

Note

Please feature/fix/update... into individual PRs (not one changing everything)

Create a github fork.
On your fork, create a branch make the changes, commit and push.
Create a pull-request.

Checklist

If applicable:

tests should be included part of your PR (pnpm g:test).

Local scripts

Name	Description
`pnpm g:typecheck`	Run typechecks in all workspaces
`pnpm g:test`	Run unit and e2e tests in all workspaces
`pnpm g:lint`	Display linter issues in all workspaces
`pnpm g:lint --fix`	Attempt to run linter auto-fix in all workspaces
`pnpm g:build`	Run build in all workspaces
`pnpm g:clean`	Clean builds in all workspaces
`pnpm clean:global-cache`	Clean tooling caches (eslint, jest...)
`pnpm deps:check --dep dev`	Will print what packages can be upgraded globally (see also .ncurc.yml)
`pnpm deps:update --dep dev`	Apply possible updates (run `pnpm install && pnpm dedupe` after)
`pnpm check:install`	Verify if there's no peer-deps missing in packages
`pnpm dedupe`	Built-in pnpm deduplication of the lock file

Git message format

This repo adheres to the conventional commit convention.

Commit messages are enforced through commitlint and a husky commit-msg hook.

Activated prefixes

chore: Changes that affect the build system or external dependencies
ci: Changes to our CI configuration files and scripts
docs: Documentation only changes
feat: A new feature
fix: A bug fix
perf: A code change that improves performance
refactor: A code change that neither fixes a bug nor adds a feature
lint: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test: Adding missing tests or correcting existing tests
translation: Adding missing translations or correcting existing ones
revert: When reverting a commit
style: A change that affects the scss, less, css styles
release: All related to changeset (pre exit...)

Note

Up-to-date configuration can be found in commitlint.config.js.

Structure

.
├── apps
│   ├── ...
│   └── nextjs-app
├── packages
│   ├── ...
│   └── core
└ package.json

4.0 KiB Raw Permalink Blame History