Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

72 lines (57 loc) · 2.3 KB
Raw

Development

Setup

Run yarn after checkout to install all dependencies.

Branch Guidelines

New branches: Please branch off of the develop branch.

Naming

Please use one of the following prefixes: (ie. feature/new-feature)

  • feature/ - development towards a new feature
  • dev/ - misc development not tied to a key feature / refactoring
  • vscode/ - development related to the VSCode Extension
  • issue/ - fix specifically for a issue #
  • bug/ - misc bug fixes not tied to a public issue
  • repo/ - meta dev related changes (ie. typescript, CI/CD, dependencies)

Tests

Tests can be run with yarn test.

Please add new tests for any new features and bug fixes. Language-specific tests should be included in their respective sqldialect.test.ts files. Tests that apply to all languages should be in behavesLikeSqlFormatter.ts.

Publish Flow

For those who have admin access on the repo, the new release publish flow is as such:

  • npm run release (bumps version, git tag, git release, npm release) (does not work with yarn).
  • git subtree push --prefix static origin gh-pages (pushes demo page to GH pages)

Contributors