Instruction file imported from Tatsh/tatsh-overlay (
.github/instructions/general.instructions.md). Copyright stays with the author.
Copilot Instructions
Bascom is a core library that provides basic functionality such as logging configuration.
General
- Do not explain project structure or conventions in comments or docstrings.
- Use 2 spaces for indentation except in Python.
- Files must end with a single newline character.
- Keep lines shorter than 100 characters.
- Line endings must be Unix-style (LF).
- Use UTF-8 encoding for all files.
- Use spaces instead of tabs for indentation.
- Use British spelling in comments and docstrings.
- Use American spelling for all identifiers and string literals, except in docstrings.
- Never mention the spelling or other project conventions in comments or docstrings.
- Use full sentences in comments and docstrings.
- Use the Oxford comma in lists.
- Use single quotes for strings, except where double quotes are required (e.g., JSON).
- Full words should be preferred over abbreviations, except for well-known acronyms. Some words may
be abbreviated:
configfor configuration.
- Prefer to use immutable data structures over mutable ones.