Skip to content
This repository was archived by the owner on Mar 22, 2024. It is now read-only.

CONTRIBUTION.md

Latest commit

 

History

History
31 lines (20 loc) · 1.56 KB

CONTRIBUTION.md

File metadata and controls

31 lines (20 loc) · 1.56 KB

Contribution Guide

Rules

make has ‘rules’. These are groups of commands that can be executed by entering make RULE-NAME your terminal. In all Next projects we have rules such as install, run, deploy, etc.

In Makefile we have two main types of rules. Common and sub.

  • Common rules are the public facing API of the Makefile. Developers/CI should run these commands.
  • Sub-rules are the inner, private workings of n-makefile. Developers/CI ought not to run these commands.

‘Common’ rule conventions

  • If we permit the rule to be overwritten it may end with % instead of its final letter, allowing it to be overwritten without producing warnings. (this is a hack, of course, and means we have to be careful about how we name our common rules!)
  • By convention, app/component Makefiles make call commonrulename-super from inside their override to run the parent common rule functionality.
  • Include a comment using the following convention for it to be automatically parsed by the help rule:
rule-nam%: ## rule-name: Rule description.

‘Sub’ rule conventions

  • Name must match the directory name they generate, if they generate a directory
  • Otherwise, _snake_case_is_used with a _ prefix
  • The name should match the pattern _commonrulename_subrulename. E.g. _run_pa11y

All rule conventions

  • Try to end each rule with a friendly @$(DONE)
  • For npm dev dependencies, assume they're there (hope that the devDependencies bring them), optionally warn the developer to install them. Don't try to install them from n-makefile.