20 lines
766 B
Markdown
20 lines
766 B
Markdown
# Git instructions
|
|
|
|
- Adhere to https://www.conventionalcommits.org for commit messages
|
|
- Maintain a `CHANGELOG.md` file adhering to https://keepachangelog.com and try
|
|
to map the conventional commit messages to the respective sections of keep a
|
|
changelog
|
|
- When creating branches, prefix them with "pi-"
|
|
|
|
# Test instructions
|
|
|
|
- Write tests in the natural tooling for the used programming language
|
|
- When doing HTTP tests, use Cypress
|
|
|
|
# Style instructions
|
|
|
|
- Avoid emojis in code outputs unless it adds significant visual help
|
|
- Use `NOTE:`, `FIXME:`, `XXX:` markers in comments where beneficial
|
|
- Never use emojis in Markdown files
|
|
- Keep line length to 80 characters in Markdown files, but do not split URLs or
|
|
code fragments (variable/function names etc.).
|