Open source projects like ember-codemod-v1-to-v2
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.
Install dependencies
-
Fork and clone this repo.
git clone [email protected]:<your-github-handle>/ember-codemod-v1-to-v2.git
-
Change directory.
cd ember-codemod-v1-to-v2
-
Use
pnpm
to install dependencies.pnpm install
Lint files
-
When you write code, please check that it meets the linting rules.
pnpm lint
-
You can run
lint:fix
to automatically fix linting errors.pnpm lint:fix
Run tests
-
When you write code, please check that all tests continue to pass.
pnpm test
Publish packages (for admins)
-
Generate a personal access token in GitHub, with default values for scopes (none selected).
-
Run the
release:changelog
script. This generates a text that you can add toCHANGELOG.md
.GITHUB_AUTH=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:changelog
-
The package follows semantic versioning. Update the version in
package.json
accordingly. -
Create a tag and provide release notes. The tag name should match the package version.
-
Publish the package.
pnpm release:publish
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 💞
-
An open source project's value comes from people using the code and extending it to make greater things. Let me know how the codemod worked on your Ember addon!
-
You can create an issue to:
- Share how you used
ember-codemod-v1-to-v2
- Share what you liked or didn't like about
ember-codemod-v1-to-v2
- Share how you used
Help with marketing 📢
-
Platforms include:
- Blog post
- GitHub star
- Meetup or conference talk
- Social media
- Word of mouth
Join this project 👩💻👨💻
-
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 v2 addons
- Respond to issues
- Review pull requests
Make issues 📝
-
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
-
When reporting a bug, please provide details to help me understand what's going on. If possible, please use the latest version of
ember-codemod-v1-to-v2
and set up a public demo that I (and others) can check the code.
💡 Have ideas for contribution? Reach out to @ijlee2
on Discord!