Skip to content

Commit f9d45a4

Browse files
author
patched.codes[bot]
committed
Patched /tmp/tmpy8z_mu3c/style.md
1 parent 2441ace commit f9d45a4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

style.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Code Style Guidelines
2+
3+
## 1. Naming Conventions
4+
- Use descriptive variable names
5+
- Adhere to PEP 8 for Python and ES6 for JavaScript
6+
7+
## 2. Code Structure
8+
- Follow the DRY (Don't Repeat Yourself) principle
9+
- Keep functions short with single responsibilities
10+
- Use const/let instead of var in JavaScript
11+
- Ensure consistent use of semicolons in JavaScript
12+
- Use JavaScript PropTypes for type checking
13+
14+
## 3. Documentation
15+
- Maintain a comprehensive README.md with project overview, table of contents, file structure, and file descriptions
16+
- Use Markdown formatting for documentation
17+
18+
## 4. Error Handling
19+
- Check for potential index out-of-range errors in lists
20+
21+
## 5. Performance
22+
- Optimize database interactions with bulk updates
23+
- Use Document Fragment to minimize DOM manipulation
24+
25+
## 6. Security
26+
- Implement SQL parameterization to prevent SQL Injection
27+
- Sanitize user inputs to prevent XSS vulnerabilities
28+
- Use bcrypt for password hashing
29+
30+
## 7. Project Structure
31+
- Organize files in appropriate directories (e.g., .github/workflows)
32+
- List project dependencies in requirements.txt
33+
34+
## 8. Version Control and CI/CD
35+
- Use GitHub for version control and pull requests for code management
36+
- Implement GitHub Actions for CI/CD, automated PR reviews, and workflow management

0 commit comments

Comments
 (0)