Recommendations and best practices
- Add a note about
nurto yourREADME.mdand link to the documentation - Add the
nurfileto git + allow each developer to extend the provided task by using anurfile.localwhich is ignored by your.gitignore - Provide some common tasks on each and every project, for me this would be something like:
nur install: Setup the project, install all dependenciesnur update: Ensure everything is up to datenur run: Start the project, might run a dev servernur halt: Stop the running projectnur test: Run the testsnur lint: Run the linternur qa: Run all QA jobs (like tests + linter)
- Use sub-tasks to group similar tasks. If you for example have tasks for exporting and importing the DB data you may use
nur db exportandnur db import - On monorepos provide the same tasks for the whole project but also variants for the different components like
nur backend testandnur frontend testwhich will both be run bynur test - When using more complex tasks, think about using modules to help you structure your tasks.
- Create tasks for all reoccurring tasks or tasks multiple people need to run
- Add docs to task (/command) and use typing
- Follow nu shell guidelines as well