Skip to content

Latest commit

 

History

History
131 lines (80 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

131 lines (80 loc) · 2.79 KB

Contributing to ember-render-helpers

Local development

Install dependencies

  1. Fork and clone this repo.

    git clone git@github.com:<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). This token will be used to retrieve pull request information.

  2. Run the release:prepare script. This removes changesets, updates package versions, and updates CHANGELOGs.

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

    Note, release:prepare also updated the workspace root's version (e.g. from 0.1.1 to 0.1.2). We will use it to name the tag that will be published.

  3. Review the file changes. Commit them in a branch, then open a pull request to merge the changes to the main branch.

    # From the workspace root
git checkout -b tag-0.1.2
git add .
git commit -m "Tagged 0.1.2"
git push origin tag-0.1.2

  4. Create a tag and provide release notes. The tag name should match the package version, prefixed by the letter v (e.g. v0.1.2).

  5. Publish the packages.

    # From the workspace root
pnpm release:publish