mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-08-30 04:40:16 +00:00
KaifAhmad1
4f66a672fa
- Restructured guides with grid cards and better formatting - Expanded cookbook to include all 39 use case notebooks - Streamlined all resource files to be concise - Removed time estimates throughout documentation - Fixed broken GitHub links - Updated version to 0.0.5 and year to 2025 - Improved architecture documentation with Mermaid diagrams - Enhanced FAQ with plain Q&A format - Made all documentation consistent and professional
127 lines
3.2 KiB
Markdown
127 lines
3.2 KiB
Markdown
# Contributing to Semantica
|
|
|
|
Thank you for your interest in contributing to Semantica!
|
|
|
|
!!! tip "Quick Start"
|
|
New to contributing? Check out issues labeled [`good-first-issue`](https://github.com/Hawksight-AI/semantica/labels/good-first-issue)
|
|
|
|
---
|
|
|
|
## 📚 Essential Links
|
|
|
|
- **[Contributing Guide](https://github.com/Hawksight-AI/semantica/blob/main/CONTRIBUTING.md)** - Complete contribution guidelines
|
|
- **[Code of Conduct](https://github.com/Hawksight-AI/semantica/blob/main/CODE_OF_CONDUCT.md)** - Community standards
|
|
- **[Security Policy](https://github.com/Hawksight-AI/semantica/blob/main/SECURITY.md)** - Report vulnerabilities
|
|
- **[GitHub Issues](https://github.com/Hawksight-AI/semantica/issues)** - Bug reports and features
|
|
|
|
---
|
|
|
|
## 🎯 Ways to Contribute
|
|
|
|
### Code Contributions
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Make your changes
|
|
4. Submit a pull request
|
|
|
|
See the [Contributing Guide](https://github.com/Hawksight-AI/semantica/blob/main/CONTRIBUTING.md) for detailed instructions.
|
|
|
|
### Documentation
|
|
|
|
- Fix typos and improve clarity
|
|
- Add examples and tutorials
|
|
- Update API documentation
|
|
- Translate documentation
|
|
|
|
### Bug Reports
|
|
|
|
Report bugs on [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) with:
|
|
- Description of the problem
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Environment details
|
|
|
|
### Feature Requests
|
|
|
|
Suggest features on [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) with:
|
|
- Use case description
|
|
- Proposed solution
|
|
- Benefits to the community
|
|
|
|
---
|
|
|
|
## ✍️ Documentation Style Guide
|
|
|
|
### Writing Guidelines
|
|
|
|
- Use clear, concise language
|
|
- Include working code examples
|
|
- Test all examples before submitting
|
|
- Follow existing documentation structure
|
|
- Use proper markdown formatting
|
|
|
|
### API Documentation Format
|
|
|
|
```python
|
|
def function_name(
|
|
param1: str,
|
|
param2: int = 0
|
|
) -> ReturnType:
|
|
"""Brief description.
|
|
|
|
Args:
|
|
param1: Description of param1
|
|
param2: Description of param2 (default: 0)
|
|
|
|
Returns:
|
|
Description of return value
|
|
|
|
Raises:
|
|
ValueError: When and why this is raised
|
|
|
|
Example:
|
|
>>> result = function_name("test", 5)
|
|
>>> print(result)
|
|
expected_output
|
|
"""
|
|
```
|
|
|
|
---
|
|
|
|
## 📁 Documentation Structure
|
|
|
|
```
|
|
docs/
|
|
├── index.md # Homepage
|
|
├── getting-started.md # Getting started
|
|
├── concepts.md # Core concepts
|
|
├── modules.md # Module overview
|
|
├── use-cases.md # Use cases
|
|
├── examples.md # Examples
|
|
├── cookbook/ # Tutorials
|
|
└── reference/ # API reference
|
|
```
|
|
|
|
---
|
|
|
|
## 🛠️ Documentation Tools
|
|
|
|
- **[MkDocs](https://www.mkdocs.org/)** - Documentation generator
|
|
- **[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)** - Theme
|
|
- **[mkdocstrings](https://mkdocstrings.github.io/)** - API docs from docstrings
|
|
- **[Mermaid](https://mermaid.js.org/)** - Diagrams
|
|
|
|
---
|
|
|
|
## 🤝 Getting Help
|
|
|
|
- **[GitHub Issues](https://github.com/Hawksight-AI/semantica/issues)** - Ask questions
|
|
- **Documentation** - Check existing docs for examples
|
|
- **Pull Requests** - Review other contributors' PRs
|
|
|
|
---
|
|
|
|
!!! success "Thank You!"
|
|
Every contribution helps make Semantica better! 🎉
|