Skip to content

Commit d6223c0

Browse files
committed
feat(docs): expand contributing guidelines to include articles section
- Updated the structure of the contributing guidelines to include a new section for Articles. - Added detailed instructions for contributing articles, including directory structure and content requirements. - Modified the pull request template to include an option for Article/Integration Guide contributions.
1 parent 322de7a commit d6223c0

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Brief description of your contribution
44
## Type of Contribution
55
- [ ] Example Tutorial
66
- [ ] Showcase Project
7+
- [ ] Article/Integration Guide
78
- [ ] Documentation Update
89
- [ ] Bug Fix
910
- [ ] Other (please describe)

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@ Thank you for your interest in contributing to our API Cookbook! We welcome high
44

55
## Structure
66

7-
This cookbook contains two main sections:
7+
This cookbook contains three main sections:
88

99
### 1. **Examples** (`/docs/examples/`)
1010
Step-by-step tutorials and example implementations that teach specific concepts or solve common use cases.
1111

1212
### 2. **Showcase** (`/docs/showcase/`)
1313
Community-built projects that demonstrate real-world applications of the Sonar API.
1414

15+
### 3. **Articles** (`/docs/articles/`)
16+
In-depth integration guides and advanced implementation tutorials for complex use cases and integrations with other tools.
17+
1518
## Contributing Guidelines
1619

1720
### What We're Looking For
@@ -91,6 +94,15 @@ Any known limitations or considerations users should be aware of.
9194
4. Include screenshots or demos if applicable
9295
5. Submit a pull request
9396

97+
### For Articles
98+
99+
1. Fork this repository
100+
2. Create a new directory under `/docs/articles/your-article-name/`
101+
3. Add your `README.mdx` file following the structure above
102+
4. Focus on advanced implementations, integrations, or complex patterns
103+
5. Include comprehensive code examples and explanations
104+
6. Submit a pull request
105+
94106
## Pull Request Template
95107

96108
When submitting a PR, please use this template:
@@ -102,6 +114,7 @@ Brief description of your contribution
102114
## Type of Contribution
103115
- [ ] Example Tutorial
104116
- [ ] Showcase Project
117+
- [ ] Article/Integration Guide
105118

106119
## Checklist
107120
- [ ] My code follows the cookbook's style guidelines

0 commit comments

Comments
 (0)