Skip to content

Latest commit

 

History

History
181 lines (109 loc) · 4.33 KB

CONTRIBUTING.md

File metadata and controls

181 lines (109 loc) · 4.33 KB

Contributing to @codemod-utils

Open source projects like @codemod-utils 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 [email protected]:<your GitHub handle>/codemod-utils.git

  2. Change directory.

    cd codemod-utils

  3. Use pnpm to install dependencies.

    pnpm install
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 publish:changelogs script. This removes changesets, updates the package versions, and updates the CHANGELOG's.

    # From the workspace root
GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm publish:changelogs

  3. The workspace root's version (e.g. 0.1.3) is more of an identifier than a (semantic) version. We will use it to name the tag that will be published.

    In the root package.json, update the version following the "highest-version" formula:

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

  4. Create a tag and provide release notes. The tag name should match the workspace root's version.

  5. Publish the packages.

    # From the workspace root
pnpm publish:packages

How can I help?

If you haven't before, I encourage you to watch Sean Massa's mini-talk on what it means to be a contributor. To sum up the talk, you can be a contributor in many ways. I want you to discover a path that meets your goals well!

Here are some suggestions to help you start:

Give feedback 💞

  1. An open source project's value comes from people using the code and extending it to make greater things. Let me know how you use @codemod-utils in your codemod!

  2. You can create an issue to:

    • Share how you used @codemod-utils
    • Share what you liked or didn't like about @codemod-utils
Help with marketing 📢

  1. Platforms include:

    • Blog post
    • GitHub star
    • Meetup or conference talk
    • Social media
    • Word of mouth
Join this project 👩‍💻👨‍💻

  1. Help me maintain the project! I have limited time and there is much that I don't know.

    • Cut releases
    • Research new ways to implement codemods
    • Respond to issues
    • Review pull requests
Make issues 📝

  1. In addition to sharing feedback (described in Give feedback), you can create an issue to:

    • Ask for better documentation
    • Ask for new feature or refactor
    • Report bug
    • Report outdated dependency

  2. When reporting a bug, please provide details to help me understand what's going on. If possible, please use the latest version of @codemod-utils and set up a public demo that I (and others) can check the code.

💡 Have ideas for contribution? Reach out to @ijlee2 on Discord!