Skip to content

nuxt-community/motd

Repository files navigation

Nuxt.js MOTD

npm version npm downloads Circle CI Codecov Number of Tips

Your source for Nuxt 2 tips

Guidelines for adding a new tip

Thank you for wanting to contribute a Nuxt.js tip. Although we appreciate all contributions, we have to follow some guidelines to make sure that each Nuxt tip we add has an as large as possible impact

A message of the day should be linked to a npm package, that can be one of the Nuxt.js core packages or one from the eco-system. For the time being we will only accept tips with regards to functionalities that almost everybody uses. In general that means either one of the core packages or one of the officially supported Nuxt modules

How to write a good tip

A good tip is:

  • short and clear but descriptive
  • does not include an opinion (unless it's a widely shared one)
  • preferably has a call-to-action
  • uses proper English (emoticons are allowed but can be problematic on the console)

Examples:

Bad

  • You should use the http module and not axios (opinon and not clear why)
  • Double quotes FTW!! (uses slang)

Good

  • Did you know you can use the husky package to run lint automatically when committing on git?
  • Most Nuxt.js projects expose a client-side api through window.$nuxt that can be used for e.g. programmatic navigation: window.$nuxt.$router.push('/my-route')

Where are these Nuxt tips used?

The Nuxt tips are shown both in the @nuxt/loading-screen as in the banner that is displayed on the @nuxt/cli when running the dev server

License

MIT