mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-08-30 04:40:16 +00:00
KaifAhmad1
03b84ab238
- Add essential open source files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, CHANGELOG.md, CONTRIBUTORS.md) - Add GitHub issue and PR templates - Add CI/CD workflows (CI, docs, release, dependabot) - Add pre-commit hooks configuration - Add documentation enhancements (architecture, governance, contributing, community) - Add developer experience scripts (setup-dev, run-tests, format-code, check-code) - Add community features (SUPPORT.md, .all-contributorsrc) - Enhance README badges and project metadata - Update mkdocs.yml navigation structure
121 lines
2.7 KiB
Markdown
121 lines
2.7 KiB
Markdown
## Description
|
|
|
|
<!-- Provide a brief description of your changes -->
|
|
|
|
## Type of Change
|
|
|
|
<!-- Mark the relevant option with an 'x' -->
|
|
|
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
|
- [ ] New feature (non-breaking change which adds functionality)
|
|
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
|
- [ ] Documentation update
|
|
- [ ] Code refactoring
|
|
- [ ] Performance improvement
|
|
- [ ] Test addition or update
|
|
- [ ] Other (please describe): ___________
|
|
|
|
## Related Issues
|
|
|
|
<!-- Link related issues using keywords like "Closes", "Fixes", "Resolves" -->
|
|
|
|
Closes #
|
|
Related to #
|
|
Fixes #
|
|
|
|
## Changes Made
|
|
|
|
<!-- List the main changes in this PR -->
|
|
|
|
- Change 1
|
|
- Change 2
|
|
- Change 3
|
|
|
|
## Testing
|
|
|
|
<!-- Describe the tests you ran and how to verify your changes -->
|
|
|
|
- [ ] Tests pass locally
|
|
- [ ] Added new tests for new functionality
|
|
- [ ] Updated existing tests
|
|
- [ ] All tests pass (`pytest`)
|
|
- [ ] Code coverage maintained or improved
|
|
|
|
### Test Results
|
|
|
|
```
|
|
Paste test output or command here
|
|
```
|
|
|
|
## Documentation
|
|
|
|
<!-- Checklist for documentation updates -->
|
|
|
|
- [ ] Updated relevant documentation
|
|
- [ ] Added code examples if applicable
|
|
- [ ] Updated API reference if adding new APIs
|
|
- [ ] Updated cookbook if adding new examples
|
|
- [ ] No documentation changes needed
|
|
|
|
## Code Quality
|
|
|
|
<!-- Checklist for code quality -->
|
|
|
|
- [ ] Code follows style guidelines (black, isort, flake8)
|
|
- [ ] Type hints added for new functions
|
|
- [ ] Docstrings added/updated
|
|
- [ ] No new warnings or errors
|
|
- [ ] Self-review completed
|
|
|
|
### Code Quality Checks
|
|
|
|
```bash
|
|
# Run these commands and ensure they pass
|
|
black semantica/ tests/
|
|
isort semantica/ tests/
|
|
flake8 semantica/ tests/
|
|
mypy semantica/
|
|
pytest
|
|
```
|
|
|
|
## Breaking Changes
|
|
|
|
<!-- If this is a breaking change, describe the impact and migration path -->
|
|
|
|
**Breaking Changes**: [Yes/No]
|
|
|
|
If yes, describe:
|
|
- What breaks
|
|
- Why it's necessary
|
|
- How to migrate
|
|
|
|
## Screenshots / Examples
|
|
|
|
<!-- If applicable, add screenshots or code examples -->
|
|
|
|
```python
|
|
# Example usage of new feature
|
|
```
|
|
|
|
## Checklist
|
|
|
|
<!-- Mark completed items with an 'x' -->
|
|
|
|
- [ ] My code follows the project's style guidelines
|
|
- [ ] I have performed a self-review of my code
|
|
- [ ] I have commented my code, particularly in hard-to-understand areas
|
|
- [ ] I have made corresponding changes to the documentation
|
|
- [ ] My changes generate no new warnings
|
|
- [ ] I have added tests that prove my fix is effective or that my feature works
|
|
- [ ] New and existing unit tests pass locally with my changes
|
|
- [ ] Any dependent changes have been merged and published
|
|
|
|
## Additional Notes
|
|
|
|
<!-- Any additional information, context, or notes for reviewers -->
|
|
|
|
## Reviewer Notes
|
|
|
|
<!-- Any specific areas you'd like reviewers to focus on -->
|
|
|