CONTRIBUTING.md

Contributing to ember-render-helpers

Local development

Install dependencies

1. Fork and clone this repo.

   git clone [email protected]:<your-github-handle>/ember-render-helpers.git

2. Change directory.

   cd ember-render-helpers

3. Use pnpm to install dependencies.

   pnpm install

Run the demo app

1. Once dependencies have been installed, you can run the test app.

   # From the workspace root
   pnpm start

2. Open the app at http://localhost:4200.

Lint files

1. When you write code, please check that it meets the linting rules.

   # From the workspace root
   pnpm lint

2. You can run lint:fix to automatically fix linting errors.

   # From the workspace root
   pnpm lint:fix

Run tests

1. When you write code, please check that all tests continue to pass.

   # From the workspace root
   pnpm test

Add changeset to pull request

1. To record how a pull request affects packages, you will want to add a changeset.

   The changeset provides a summary of the code change. It also describes how package versions should be updated (major, minor, or patch) as a result of the code change.

   # From the workspace root
   pnpm changeset

Publish packages (for admins)

1. Generate a personal access token in GitHub, with default values for scopes (none selected).

2. Run the release:changelog script. This removes changesets, updates the package versions, and updates the CHANGELOG's.

   # From the workspace root
   GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:changelog

   The release:changelog script also updated the workspace root's version (by following the highest version formula). We will use it to name the tag that will be published.

   # Highest version formula
   workspace root version = max(
     max(all package versions),
     workspace root version + 0.0.1,
   );
   

3. Create a tag and provide release notes. The tag name should match the package version, prefixed by the letter v. For example, v1.0.0.

4. Publish the packages.

   # From the workspace root
   pnpm release:package