-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Downstreamed changes from @embroider/addon-blueprint#113. Added CONTR…
…IBUTING.md. (#29) * chore: Updated dependencies * chore: Added CONTRIBUTING.md * chore: Downstreamed changes from @embroider/addon-blueprint#113 * chore: Updated test fixtures * chore: Updated latestVersions * chore: Updated test fixtures --------- Co-authored-by: ijlee2 <[email protected]>
- Loading branch information
Showing
24 changed files
with
296 additions
and
134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,12 @@ | ||
| # compiled output | ||
| /dist/ | ||
| /tmp/ | ||
|
|
||
| # dependencies | ||
| /node_modules/ | ||
|
|
||
| # misc | ||
| !.* | ||
| .*/ | ||
| .eslintcache | ||
| /src/blueprints/ | ||
| /tests/fixtures/ | ||
| /tmp/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| # Contributing to ember-codemod-v1-to-v2 | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| ## Local development | ||
|
|
||
| <details> | ||
| <summary>Install dependencies</summary> | ||
|
|
||
| 1. Fork and clone this repo. | ||
|
|
||
| ```sh | ||
| git clone [email protected]:<your GitHub handle>/ember-codemod-v1-to-v2.git | ||
| ``` | ||
|
|
||
| 1. Change directory. | ||
|
|
||
| ```sh | ||
| cd ember-codemod-v1-to-v2 | ||
| ``` | ||
|
|
||
| 1. Use `yarn` to install dependencies. | ||
|
|
||
| ```sh | ||
| yarn install | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
| <summary>Lint files</summary> | ||
|
|
||
| 1. When you write code, please check that it meets the linting rules. | ||
|
|
||
| ```sh | ||
| yarn lint | ||
| ``` | ||
|
|
||
| 1. You can run `lint:fix` to automatically fix linting errors. | ||
|
|
||
| ```sh | ||
| yarn lint:fix | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
| <summary>Run tests</summary> | ||
|
|
||
| 1. When you write code, please check that all tests continue to pass. | ||
|
|
||
| ```sh | ||
| yarn test | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
|
|
||
| <summary>Publish packages (for admins)</summary> | ||
|
|
||
| 1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with default values for scopes (none selected). | ||
|
|
||
| 1. Create a pull request, in which you update the package version and `CHANGELOG`. | ||
|
|
||
| ```sh | ||
| GITHUB_AUTH=<YOUR_PERSONAL_ACCESS_TOKEN> yarn changelog | ||
| ``` | ||
|
|
||
| 1. Create a tag such as `1.0.0` (the name satisfies the regular expression `^\d+\.\d+\.\d+`). | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| ## How can I help? | ||
|
|
||
| If you haven't before, I encourage you to watch [Sean Massa's mini-talk](https://www.youtube.com/watch?v=CcSKlsc_AhQ) 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: | ||
|
|
||
|
|
||
| <details> | ||
| <summary>Give feedback 💞</summary> | ||
|
|
||
| 1. 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! | ||
| 1. 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` | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
| <summary>Help with marketing 📢</summary> | ||
|
|
||
| 1. Platforms include: | ||
|
|
||
| - Blog post | ||
| - GitHub star | ||
| - Meetup or conference talk | ||
| - Social media | ||
| - Word of mouth | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
| <summary>Join this project 👩💻👨💻</summary> | ||
|
|
||
| 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 v2 addons | ||
| - Respond to issues | ||
| - Review pull requests | ||
| </details> | ||
| <details> | ||
| <summary>Make issues 📝</summary> | ||
| 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 | ||
| 1. 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 (other people) can check the code. | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| 💡 Have ideas for contribution? Reach out to `@ijlee2` on [Discord](https://discord.com/invite/emberjs)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.