CONTRIBUTING.md

Contributing

Stack

• Node.js
• Eleventy
• Nunjucks
• Vanilla CSS
• Vanilla JS

Setup

npm install

Development

node --run dev

Formatting

node --run format

Linting

# Run all linters
node --run lint

# Run individual linters
node --run lint:css
node --run lint:js
node --run lint:data
node --run lint:format

Production

node --run build

Edit a flag

Either use the edit links on each flag page for minor edits with the GitHub web interface.

Or fork the repository and make changes with your preferred code editor.

Each flag consists of two files, where [id] is the URL-safe lowercase and hyphenated name of the flag:

• Data file: data/flags/[id].yaml
• Image file: public/img/[id].svg

Add a flag

To add a flag, create the following two files, where [id] is the URL-safe lowercase and hyphenated name of the flag:

• Data file: data/flags/[id].yaml
• Image file: public/img/[id].svg

The mandatory and optional properties for the YAML data file are specified in the flag JSON schema.

The flag image file should be an optimized SVG that uses basic shapes to improve readability and reusability.