Skip to content

Commit 79bb239

Browse files
committed
feat: align templates and README with OSCG'26 guidelines
- Update issue templates with OSCG context and enhanced quality standards - Enhance PR template with OSCG quality checklist and contributor notice - Add OSCG participation notice and contributing section to README - Update issue config to direct contributors to OSCG guidelines - Maintain high quality standards for OSCG'26 participation
1 parent c856164 commit 79bb239

6 files changed

Lines changed: 84 additions & 16 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for taking the time to file a bug report.
9+
Thanks for taking the time to file a bug report! 🚀
10+
11+
**OSCG'26 Contributors**: This project participates in the Open Source Contributor Games 2026.
12+
High-quality contributions are rewarded with points, recognition, and networking opportunities.
13+
Please ensure your report follows our [quality standards](../CONTRIBUTING.md) for maximum impact.
1014
1115
- type: textarea
1216
id: summary
@@ -66,10 +70,16 @@ body:
6670
render: shell
6771

6872
- type: checkboxes
69-
id: terms
73+
id: quality_standards
7074
attributes:
71-
label: Code of Conduct
72-
description: By submitting this issue, you agree to follow our Code of Conduct.
75+
label: Quality Standards & Code of Conduct
76+
description: By submitting this issue, you agree to our standards and conduct expectations.
7377
options:
78+
- label: I have searched existing issues to avoid duplicates
79+
required: true
80+
- label: I have provided clear, reproducible steps
81+
required: true
7482
- label: I agree to follow this project's Code of Conduct
7583
required: true
84+
- label: I understand this project participates in OSCG'26 quality standards
85+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Questions or discussions
44
url: https://github.com/aviralgarg05/NexumDB/discussions
5-
about: Ask questions, brainstorm ideas, or request guidance.
5+
about: Ask questions, brainstorm ideas, or request guidance. OSCG'26 participants welcome!
6+
- name: OSCG'26 Contribution Guidelines
7+
url: https://github.com/aviralgarg05/NexumDB/blob/main/CONTRIBUTING.md
8+
about: Read our comprehensive guidelines for OSCG'26 contributors to maximize your impact and score.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for suggesting an improvement!
9+
Thanks for suggesting an improvement! 🎨
10+
11+
**OSCG'26 Contributors**: NexumDB participates in the Open Source Contributor Games 2026.
12+
Well-researched feature requests contribute to your OSCG score and help advance AI database technology.
13+
Please provide comprehensive details following our [contribution guidelines](../CONTRIBUTING.md).
1014
1115
- type: textarea
1216
id: summary
@@ -32,17 +36,34 @@ body:
3236
label: Alternatives Considered
3337
description: List any alternative solutions or workarounds you have considered.
3438

39+
- type: textarea
40+
id: impact
41+
attributes:
42+
label: Impact Assessment
43+
description: How will this feature benefit users? What's the expected adoption?
44+
placeholder: This feature would improve query performance by 2x for JOIN operations, benefiting data analysts...
45+
validations:
46+
required: true
47+
3548
- type: textarea
3649
id: additional
3750
attributes:
3851
label: Additional Context
3952
description: Add any other context, diagrams, or references to existing issues.
4053

4154
- type: checkboxes
42-
id: terms
55+
id: quality_standards
4356
attributes:
44-
label: Code of Conduct
45-
description: By submitting this issue, you agree to follow our Code of Conduct.
57+
label: Quality Standards & Code of Conduct
58+
description: By submitting this feature request, you agree to our standards.
4659
options:
60+
- label: I have searched existing issues and discussions
61+
required: true
62+
- label: I have provided clear business value and use cases
63+
required: true
64+
- label: I understand the technical complexity involved
65+
required: true
4766
- label: I agree to follow this project's Code of Conduct
4867
required: true
68+
- label: I understand this project participates in OSCG'26 quality standards
69+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 🚀 OSCG'26 Contributor Notice
2+
**NexumDB participates in the Open Source Contributor Games 2026!** High-quality PRs earn you points, recognition, and networking opportunities. Please follow our [contribution guidelines](../CONTRIBUTING.md) for maximum impact and ensure your submission meets OSCG quality standards.
3+
14
## Summary
25
<!-- Provide a clear and concise description of what this PR changes and why it's needed -->
36

@@ -60,15 +63,25 @@ Closes #(issue_number) <!-- Link related issues with "Closes #123" or "Fixes #45
6063
- [ ] Added/updated examples in `demo.sh` (if applicable)
6164

6265
## Pre-Merge Checklist
63-
- [ ] Self-reviewed my own code
64-
- [ ] Added tests covering my changes
66+
- [ ] Self-reviewed my own code thoroughly
67+
- [ ] Added comprehensive tests covering my changes
6568
- [ ] All existing tests pass locally
6669
- [ ] Updated relevant documentation
6770
- [ ] No uncommitted debug code or console logs
6871
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
6972
- [ ] Follows [Code of Conduct](CODE_OF_CONDUCT.md)
7073
- [ ] Branch is up to date with `main`
7174

75+
## 🎯 OSCG'26 Quality Standards
76+
By submitting this PR, I confirm:
77+
- [ ] I have read and follow the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
78+
- [ ] My contribution meets OSCG'26 quality standards for production-ready code
79+
- [ ] I have tested my changes thoroughly across different scenarios
80+
- [ ] I understand the zero-tolerance policy for low-quality submissions
81+
- [ ] My code follows established patterns and maintains consistency
82+
- [ ] I have considered performance, security, and maintainability impacts
83+
- [ ] I acknowledge this project's participation in OSCG'26 and uphold its reputation
84+
7285
## Additional Notes
7386
<!-- Any additional context, deployment notes, follow-up tasks, or breaking changes details -->
7487

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
# NexumDB - AI-Native Database
99

10+
> 🚀 **OSCG'26 Participant**: NexumDB proudly participates in the Open Source Contributor Games 2026! High-quality contributions earn points, recognition, and networking opportunities. [Join us →](CONTRIBUTING.md)
11+
1012
An innovative, open-source database that combines traditional SQL with AI-powered features including advanced query operators, natural language processing, semantic caching, and reinforcement learning-based query optimization.
1113

1214
## Architecture
@@ -253,6 +255,25 @@ No configuration needed - just use the database!
253255
- **Type-Safe**: Rust core with comprehensive error handling
254256
- **Well-Tested**: Full unit and integration test coverage
255257

258+
## 🤝 Contributing to NexumDB
259+
260+
**Ready to shape the future of AI-native databases?** NexumDB participates in the **Open Source Contributor Games 2026 (OSCG'26)**!
261+
262+
### 🎯 Why Contribute?
263+
- **Impact**: Build cutting-edge database technology used by developers worldwide
264+
- **Recognition**: Earn OSCG points, badges, and community recognition
265+
- **Learning**: Master Rust, Python, AI/ML, and database internals
266+
- **Networking**: Connect with top developers, mentors, and industry professionals
267+
- **Career**: Gain valuable open-source experience for your portfolio
268+
269+
### 🚀 Get Started
270+
1. Read our comprehensive [Contributing Guide](CONTRIBUTING.md)
271+
2. Check out [Good First Issues](https://github.com/aviralgarg05/NexumDB/labels/good%20first%20issue)
272+
3. Join our [Discussions](https://github.com/aviralgarg05/NexumDB/discussions) for questions
273+
4. Follow our [Code of Conduct](CODE_OF_CONDUCT.md)
274+
275+
**Quality First**: We maintain high standards and provide mentorship to help you succeed. Every contribution matters, from bug fixes to major features!
276+
256277
## License
257278

258279
MIT

nexum_core/run_benchmarks.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ echo ""
2727
run_benchmark() {
2828
local bench_name=$1
2929
local description=$2
30-
30+
3131
echo "Running $description..."
3232
echo " Benchmark: $bench_name"
33-
33+
3434
# Run the benchmark and capture output
3535
if cargo bench --bench "$bench_name" 2>&1 | tee "$RESULTS_DIR/${bench_name}_output.log"; then
3636
echo " $description completed successfully"
@@ -71,7 +71,7 @@ cat > "$RESULTS_DIR/summary.md" << EOF
7171
## Benchmark Suites Executed
7272
7373
- Storage Engine Benchmarks
74-
- SQL Parser Benchmarks
74+
- SQL Parser Benchmarks
7575
- Query Executor Benchmarks
7676
- Filter Evaluation Benchmarks
7777
@@ -102,7 +102,7 @@ Open \`criterion/report/index.html\` in a web browser for:
102102
103103
### Key Metrics to Monitor
104104
- **Storage Write Throughput**: Target >10,000 ops/sec
105-
- **Storage Read Throughput**: Target >50,000 ops/sec
105+
- **Storage Read Throughput**: Target >50,000 ops/sec
106106
- **SQL Parse Time**: Target <1ms for simple queries
107107
- **Query Execution**: Target >1,000 records/ms
108108
- **Filter Evaluation**: Target <1μs per row
@@ -133,4 +133,4 @@ echo " Then open: http://localhost:8000/criterion/report/index.html"
133133
echo ""
134134
echo "🔍 To compare with previous runs:"
135135
echo " ls benchmark_results/"
136-
echo ""
136+
echo ""

0 commit comments

Comments
 (0)