Skip to content

Commit e7dbff9

Browse files
committed
docs: add missing guides to contributing README
- Added github-markdown-pitfalls.md to the quick reference table - Added testing/ directory link for testing conventions - Ensures all contribution guides are properly listed
1 parent 19382f8 commit e7dbff9

1 file changed

Lines changed: 17 additions & 15 deletions

File tree

docs/contributing/README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ This guide will help you understand our development practices and contribution w
44

55
## 📋 Quick Reference
66

7-
| Topic | File |
8-
| ------------------------------------ | -------------------------------------------------- |
9-
| DDD layer placement (architecture) | [ddd-layer-placement.md](./ddd-layer-placement.md) |
10-
| PR review guide for reviewers | [pr-review-guide.md](./pr-review-guide.md) |
11-
| Creating roadmap issues | [roadmap-issues.md](./roadmap-issues.md) |
12-
| Branching conventions | [branching.md](./branching.md) |
13-
| Commit process and pre-commit checks | [commit-process.md](./commit-process.md) |
14-
| Code quality and linting | [linting.md](./linting.md) |
15-
| Module organization and imports | [module-organization.md](./module-organization.md) |
16-
| Error handling principles | [error-handling.md](./error-handling.md) |
17-
| Working with Tera templates | [templates.md](./templates.md) |
18-
| Debugging techniques | [debugging.md](./debugging.md) |
19-
| Spell checking and dictionaries | [spelling.md](./spelling.md) |
20-
| Known issues and expected behaviors | [known-issues.md](./known-issues.md) |
21-
| Logging best practices | [logging-guide.md](./logging-guide.md) |
7+
| Topic | File |
8+
| ------------------------------------ | ------------------------------------------------------------ |
9+
| DDD layer placement (architecture) | [ddd-layer-placement.md](./ddd-layer-placement.md) |
10+
| PR review guide for reviewers | [pr-review-guide.md](./pr-review-guide.md) |
11+
| Creating roadmap issues | [roadmap-issues.md](./roadmap-issues.md) |
12+
| Branching conventions | [branching.md](./branching.md) |
13+
| Commit process and pre-commit checks | [commit-process.md](./commit-process.md) |
14+
| Code quality and linting | [linting.md](./linting.md) |
15+
| Module organization and imports | [module-organization.md](./module-organization.md) |
16+
| Error handling principles | [error-handling.md](./error-handling.md) |
17+
| Working with Tera templates | [templates.md](./templates.md) |
18+
| Debugging techniques | [debugging.md](./debugging.md) |
19+
| Spell checking and dictionaries | [spelling.md](./spelling.md) |
20+
| Known issues and expected behaviors | [known-issues.md](./known-issues.md) |
21+
| Logging best practices | [logging-guide.md](./logging-guide.md) |
22+
| GitHub Markdown pitfalls | [github-markdown-pitfalls.md](./github-markdown-pitfalls.md) |
23+
| Testing conventions and practices | [testing/](./testing/) |
2224

2325
## 🚀 Getting Started
2426

0 commit comments

Comments
 (0)