Skip to content

Commit c43c0bc

Browse files
committed
add contributing rules
1 parent c53e869 commit c43c0bc

File tree

2 files changed

+76
-15
lines changed

2 files changed

+76
-15
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,70 @@
1-
# Contributing
1+
# Contribution Guidelines for API Cookbook Repository
22

3-
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
3+
Thank you for your interest in contributing to our API Cookbook repository! We're looking for high-quality, impactful projects that showcase the capabilities of our API and provide genuine value to developers.
54

6-
Please note we have a code of conduct, please follow it in all your interactions with the project.
5+
## Project Quality Standards
6+
7+
We prioritize quality over quantity in all contributions. Here's what we look for:
8+
9+
### Technical Requirements
10+
11+
- **Functional Completeness**: Your project should be fully functional, free of bugs, and include proper error handling.
12+
- **Code Quality**: Code should be clean, well-formatted, well-documented, and follow standard best practices for the language/framework used.
13+
- **Documentation**: Include comprehensive README with:
14+
- Clear description of what the project does
15+
- Installation/setup instructions
16+
- Usage examples
17+
- Explanation of how the API is leveraged
18+
- Any limitations or considerations
19+
- **Maintainability**: Code should be structured to be easily maintained and extended.
20+
21+
### Impact Criteria
22+
23+
We're especially interested in projects that demonstrate one or more of the following:
24+
25+
1. **Solves Real Problems**: Addresses actual use cases that developers might encounter
26+
2. **Educational Value**: Teaches important concepts about API usage or implementation patterns
27+
3. **Novel Applications**: Shows innovative or unexpected ways to leverage the API
28+
4. **Vertical-Specific Solutions**: Demonstrates the API's utility in specific industries or domains
29+
5. **Integration Examples**: Shows how to effectively combine our API with other tools or services
30+
31+
## Submission Process
32+
33+
1. **Fork the Repository**: Create your own fork of the cookbook repository
34+
2. **Create a New Directory**: Name it descriptively after your project
35+
3. **Implement Your Project**: Follow the quality guidelines above
36+
4. **Test Thoroughly**: Ensure everything works as expected
37+
5. **Update the README**: Add your project to the README for visibility.
38+
5. **Submit a Pull Request**: Include a detailed description of your project and what makes it valuable
39+
40+
## Review Criteria
41+
42+
When reviewing submissions, we evaluate based on:
43+
44+
- **Functionality**: Does it work as described?
45+
- **Code Quality**: Is the implementation well-crafted?
46+
- **Originality**: Does it add something new to the cookbook?
47+
- **Usefulness**: Would other developers find this helpful?
48+
- **Documentation**: Is it well-explained and easy to follow?
49+
50+
## Examples of High-Impact Projects
51+
52+
- A specialized search application focused on a particular domain (e.g., legal research, academic papers)
53+
- A browser extension that enhances productivity or learning
54+
- An automated workflow tool that solves a specific business problem
55+
- An integration with popular platforms or productivity tools
56+
- An innovative data visualization of API results
57+
- A tool addressing a specific industry challenge
58+
59+
## What to Avoid
60+
61+
- Projects with minimal functionality beyond basic API calls
62+
- Poorly documented implementations
63+
- Projects that essentially duplicate existing cookbook examples
64+
- Code with security issues or significant bugs
65+
- Projects focused on prohibited use cases
66+
67+
Thank you for helping us build a valuable resource for our developer community! We look forward to seeing your innovative applications of our API.
768

869
## Pull Request Process
970

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
A collection of practical applications and tools built with [Perplexity's Sonar API](https://sonar.perplexity.ai/), the fastest, most cost-effective AI answer engine with robust search capabilities.
44

5+
## Contributing
6+
7+
Contributions to this repository are welcome! Whether you want to:
8+
9+
- Fix bugs in existing projects
10+
- Add new features to current tools
11+
- Contribute entirely new Sonar API projects
12+
- Improve documentation or examples
13+
14+
Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines.
15+
516
## ⚠️ API Key Required
617

718
**Before you begin:** You'll need a Perplexity API key to use any project in this repository.
@@ -56,17 +67,6 @@ The API offers:
5667
- Straightforward documentation
5768
- Transparent usage-based pricing
5869

59-
## Contributing
60-
61-
Contributions to this repository are welcome! Whether you want to:
62-
63-
- Fix bugs in existing projects
64-
- Add new features to current tools
65-
- Contribute entirely new Sonar API projects
66-
- Improve documentation or examples
67-
68-
Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines.
69-
7070
## License
7171

7272
Unless otherwise specified, all projects in this repository are licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

0 commit comments

Comments
 (0)