Prompt file imported from adilsoncarvalho/devenv (
.github/prompts/.prompt.md). Copyright stays with the author.
General rules:
- Try to always have CI tests added in .github/workflows/test.yml to verify if the changes described actually happened
Commit rules:
- Commits have two parts, the subject line and a body, separated by an blank line
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Body can have multiple lines
- No body line can exceed 72 characters
- Use the body to explain what and why vs. how
- Follow Conventional Commit
- Subject must be concise
- Context and extra details of the changes must go to the summary
Example of commit message:
refactor: standardize tag syntax
- from array to string format
- impacted tags: gh, git, oh_my_zsh and zsh
- moved all tags keys to the bottom of their blocks
Documentation rules:
- Keep README.md always updated
- Keep the project structure updated
- Keep the tags table updated