Standardize the use of yarn and npm scripts in the Ember experience, for test and start

[jenweber]

The purpose of this issue is to coordinate work to write the RFC. This is not a "pre-rfc" discussion.

Background info for volunteers

Across Ember's learning resources, blueprints, and more, we show examples that rely on someone having ember-cli globally installed, such as ember serve. In some cases, we could show npm script commands such as npm start or yarn start. The aim is to improve developer experience. Many teams already do this - you don't have to worry about special syntax when working in different codebases if all of them use npm start. Another example is npm test versus ember test.

Please see the discussion on this ticket to learn about some reasons we want to propose the change: ember-cli/ember-cli#9514 If you want to discuss any of the points raised to understand how to incorporate them into the PR, please have that discussion here and not in the PR thread.

Goals

Our goal is to do have a first draft by July 3rd.

Tips

In my opinion, this should be a short RFC. An example of a short RFC is RFC 196

Grammar and wording do not need to be perfect. Let's get a first draft done and then improve it!

To do

There are multiple people who volunteered to help! Here are the tasks we can divide up, roughly in order that we should do them. Please comment below if you want to take the lead on a task!

• @MehulKChaudhari Start a document for writing the first draft (I like notion the best for quick, collaborative editing, but it's your pick). Paste in the RFC template. Add other volunteers as editors.
• @dhanush027 Write the summary and motivation, based on the comments in the PR linked above. Also include some of the advice from nullvoxpopuli on Twitter to help support the change.
• @dhanush027 Find some examples that we can use in the RFC. Search the Ember CLI Guides for uses of the "ember" global command for test or start. Share a few of of them with the group. Only search the "release" folder of the guides and not older versions.
  • After the step above - write a "detailed design" section that links to an example in the live guides site. Paste in one of the examples, and show a "before and after" example of how that page would change
• In "how we teach this" - add a list that summarizes what resources would need to change (just a bullet point list). The list should include ember-cli guides, ember guides, ember API documentation, the Super Rentals tutorial, and the blueprints in ember-cli https://github.com/ember-cli/ember-cli
• Everyone should add questions to "unresolved questions" as we work. One question I have is, how does the difference between yarn 1, 2, and 3 affect us if we made this change?
• Write the alternatives section. I think the only alternative is "no change"
• Write the "drawbacks" section. I think the main drawback is that new devs may be confused about when to use the "ember" command instead of npm/yarn. Add your own ideas about how we could guide them and mitigate this issue.
• Finally, open a PR to the RFCs repo!

[MehulKChaudhari]

Hey Jen, I am starting with creating a notion doc for the first draft.

[dhanushkumar-dev]

Hey Jen,
I'll start with writing the summary and motivation for the change and add some examples to use in RFC.

[jenweber]

Hi @dhanush027 did you have the chance to draft something? We can add it to @MehulKChaudhari's document.

@MehulKChaudhari thanks for making the doc. Are you interested in doing some of the other steps next?

[jenweber]

I think there was a third volunteer - I will check in with them to see if they are still interested as well.

[MehulKChaudhari]

Hi @dhanush027 did you have the chance to draft something? We can add it to @MehulKChaudhari's document.

@MehulKChaudhari thanks for making the doc. Are you interested in doing some of the other steps next?

Yes, I would be doing more steps this weekend.

[dhanushkumar-dev]

Hi @dhanush027 did you have the chance to draft something? We can add it to @MehulKChaudhari's document.

@MehulKChaudhari thanks for making the doc. Are you interested in doing some of the other steps next?

Yes.
I have drafted the summary part, will get the other tasks done by 27th and add it in @MehulKChaudhari's document.

[jenweber]

Hello all, I had the incorrect link in the description. For the general comments/advice about why we want to make this change, please see ember-cli/ember-cli#9514

[wagenet]

@jenweber @dhanush027 how's it going?

[wagenet]

Looks like it is #831!

[dhanushkumar-dev]

Looks like it is #831!

Yup.
Please let us know if you have any suggestions and comments.
Thank you 🙂

[jenweber]

Since there’s now an RFC PR posted, I consider this issue complete, and I will close it. Thank you!