teable/CONTRIBUTING.md

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 (yarn g:test-unit).
• a changeset should be provided (yarn g:changeset) to request a version bump.
• documentation should be updated (yarn g:build-doc to rebuild the api doc).

Local scripts

Name	Description
yarn g:changeset	Add a changeset to declare a new version
yarn g:typecheck	Run typechecks in all workspaces
yarn g:lint	Display linter issues in all workspaces
yarn g:lint --fix	Attempt to run linter auto-fix in all workspaces
yarn g:test-unit	Run unit tests in all workspaces
yarn g:build	Run build in all workspaces
yarn g:clean	Clean builds in all workspaces
yarn g:check-dist	Ensure build dist files passes es2017 (run g:build first).
yarn g:check-size	Ensure build files are within size limit (run g:build first).
yarn g:build-doc	Build documentation (generally api doc)
yarn clean:global-cache	Clean tooling caches (eslint, jest...)
yarn deps:check --dep dev	Will print what packages can be upgraded globally (see also .ncurc.yml)
yarn deps:update --dep dev	Apply possible updates (run yarn install && yarn dedupe after)
yarn check:install	Verify if there's no peer-deps missing in packages
yarn dedupe	Built-in yarn 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
│   ├── ...
│   └── ts-utils
└ package.json