Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.65 KB

developing.md

File metadata and controls

53 lines (34 loc) · 1.65 KB
Raw

Developing

Get Started

  1. Clone the repository, and cd into it.
git clone [email protected]:forcedotcom/schemas.git
  1. Ensure you have NodeJS installed and run the following to build:
yarn install

Branches

  • Our released (aka. production) branch is main.
  • Our work happens in topic branches (feature and/or bug-fix).
    • feature as well as bug-fix branches are based on main
      • Topic branches can live in forks (external contributors) or within this repository (committers). ** When creating topic branches in this repository please prefix with <developer-name>/.
    • branches should be kept up-to-date using rebase
    • see below for further merge instructions

Merging between branches

  • We try to limit merge commits as much as possible.

    • They are usually only ok when done by our release automation.

  • Topic branches are:

    1. based on main and will be
    2. squash-merged into main.

  • Hot-fix branches are an exception.

    • Instead we aim for faster cycles and a generally stable main branch.

Making Pull Requests

Take a look at CONTRIBUTING doc for making and merging pull requests.

Testing

Run the following to test library and plugin:

yarn test

If you are using VS Code for development, the following launch configurations are available: "Run All Tests", "Run Current Test", "Run Current Test Without Compile". Have "debug.javascript.usePreview": true in your user setting enabled so you can utilize vscode-js-debug debugger. This setting is enabled by default in VS Code version 1.47.