mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-08-29 04:26:20 +00:00
Mohd Kaif
6f310d1d7a
Surfaces the comment-before-you-PR workflow from CONTRIBUTING.md directly on the PR creation page to reduce duplicate PRs on the same issue.
79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
> **Before you submit:** make sure you followed the [issue workflow in CONTRIBUTING.md](https://github.com/semantica-agi/semantica/blob/main/CONTRIBUTING.md#-working-on-an-existing-issue) — comment on the issue and wait for assignment before opening a PR, to avoid duplicate work.
|
|
|
|
## Description
|
|
|
|
<!-- Provide a clear description of your changes -->
|
|
|
|
## Type of Change
|
|
|
|
- [ ] 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
|
|
- [ ] Performance improvement
|
|
- [ ] Code refactoring
|
|
|
|
## Related Issues
|
|
|
|
<!-- Link related issues using keywords like "Closes", "Fixes", "Resolves" -->
|
|
|
|
Closes #
|
|
Fixes #
|
|
|
|
## Changes Made
|
|
|
|
<!-- List the main changes in this PR -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
## Testing
|
|
|
|
<!-- Describe how you tested your changes -->
|
|
|
|
- [ ] Tested locally
|
|
- [ ] Added tests for new functionality
|
|
- [ ] Package builds successfully (`python -m build`)
|
|
|
|
### Test Commands
|
|
|
|
```bash
|
|
# Build the package
|
|
pip install build
|
|
python -m build
|
|
|
|
# Optional: Run your own tests
|
|
pytest tests/
|
|
|
|
# Optional: Format code
|
|
black semantica/
|
|
isort semantica/
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [ ] 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
|
|
|
|
## Breaking Changes
|
|
|
|
**Breaking Changes**: [Yes/No]
|
|
|
|
<!-- If yes, describe the impact and migration path -->
|
|
|
|
## Checklist
|
|
|
|
- [ ] 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
|
|
- [ ] My changes generate no new warnings
|
|
- [ ] Package builds successfully
|
|
|
|
## Additional Notes
|
|
|
|
<!-- Any additional information for reviewers -->
|