Skip to content

Latest commit

 

History

History
89 lines (51 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

89 lines (51 loc) · 1.75 KB
Raw

Contributing to ember-codemod-rename-test-modules

Open source projects like ember-codemod-rename-test-modules live on your words of encouragement and contribution. Please give feedback, report issues, or submit pull requests!

Here are some guidelines to help you and everyone else.

Local development

Install dependencies

  1. Fork and clone this repo.

    git clone git@github.com:<your-github-handle>/ember-codemod-rename-test-modules.git

  2. Change directory.

    cd ember-codemod-rename-test-modules

  3. Use pnpm to install dependencies.

    pnpm install
Lint files

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

    pnpm lint

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

    pnpm lint:fix
Run tests

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

    pnpm test
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 generates a text that you can add to CHANGELOG.md.

    GITHUB_AUTH=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:changelog

  3. The package follows semantic versioning. Update the version in package.json accordingly.

  4. Create a tag and provide release notes. The tag name should match the package version.

  5. Publish the package.

    pnpm release:publish