Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.48 KB

DEVELOPING.md

File metadata and controls

59 lines (39 loc) · 1.48 KB
Raw

Developing

Getting Started

Clone the project and cd into it:

git clone [email protected]:forcedotcom/agents.git
cd agents

Ensure you have Yarn installed, then run:

yarn install
yarn build

Branches

  • Our released (production) branch is main
  • Our work happens in topic branches (feature and/or bug fix)
    • These branches are based on main and can live in forks for external contributors or within this repository for authors
    • Be sure to prefix branches in this repository with <developer-name>/
    • Be sure to keep branches up-to-date using rebase

Testing

Running the test suite

Runs the suite and output code coverage as a text summary:

yarn test

Utilize the Run Tests VS Code debugger configuration to run the test suite with the debugger enabled.

Testing in another package

To test the library in another local package, you can link it to such module so any changes that are built will be automatically present without reinstalling:

yarn local:link /path/to/other/project

to unlink the library:

yarn local:unlink /path/to/other/project

Testing with the NPM artifact

The library can also be installed to another local project as a regular NPM module. This is useful for manually testing the package that will be deployed to NPM. Use this instead of the linking process that's described under Development to QA changes before they are published:

yarn local:install /path/to/other/package