- use org mode formatting
- NEVER use bold or italics.
- use org headers that start with asterisks to separate sections, and use subheaders as necessary
- wrap code in org source blocks, like this
console.log("Hello, world!")- Code should be easy to read and understand.
- Keep the code as simple as possible. Avoid unnecessary complexity.
- Use meaningful names for variables, functions, classes, etc. Names should reveal intent.
- Functions should be small and do one thing well. They should not exceed a few lines.
- Function names should describe the action being performed.
- Prefer fewer arguments in functions. Ideally, aim for no more than two or three.
- Only use comments when necessary, as they can become outdated. Instead, strive to make the code self-explanatory.
- When comments are used, they should add useful information that is not readily apparent from the code itself.
- Properly handle errors and exceptions to ensure the software’s robustness.
- Use exceptions rather than error codes for handling errors.
- Consider security implications of the code. Implement security best practices to protect against vulnerabilities and attacks.
- Adhere to these principles of Functional Programming
- Pure Functions
- Immutability
- Function Composition
- Declarative Code