mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-08-29 04:26:20 +00:00
KaifAhmad1
9113ef3428
- Rewrote all 26 reference module pages: removed blockquote taglines and horizontal rule separators, added "What You Get" bullet summaries, added constructor/method parameter tables, expanded thin files (graph_store, triplet_store, visualization, provenance) with full API coverage, added backend comparison tables and real-world usage patterns - Renamed Modules tab from "API Reference" and group from "Context & Knowledge" to "Context & Intelligence" in docs.json - Fixed logo: copied "Semantica Logo.png" to web-safe semantica-logo.png and updated all 4 references in docs.json - Improved core docs (index, modules, concepts, quickstart, installation, getting-started) with better fonts, bullet points, and complete module listings (mcp_server, evals, core, utils previously missing) - Rewrote community pages (community, community-projects, contributing-guide, use-cases, architecture, faq, learning-more, glossary) with heading hierarchy fixes, expanded definitions, and better structure - Fixed markdown linter warnings: MD036 bold-as-heading, MD001 heading skips, MD040 missing code fence language, MD032 blank lines around lists
3.4 KiB
3.4 KiB
title, description, icon
| title | description | icon |
|---|---|---|
| Contributing | How to contribute code, documentation, tests, and community support to Semantica. | code-pull-request |
Contributions of all kinds are welcome — code, documentation, tests, and community support. Every contribution is recognized in release notes and the GitHub contributors list.
Quick Start
# Fork the repo on GitHub, then:
git clone https://github.com/your-username/semantica.git
cd semantica
pip install -e ".[dev]"
pytest
New to the project? Start with good-first-issue labeled tickets — they're scoped to be completable in a few hours without deep codebase knowledge.
Ways to Contribute
Code
- Fix bugs and resolve open issues
- Implement new features or integrations
- Optimize performance or refactor existing modules
- Add new ingestors, parsers, or exporters using the plugin registry
Documentation
- Fix typos, improve clarity, and add missing examples
- Write tutorials or domain-specific cookbook notebooks
- Keep the API reference accurate as modules evolve
Testing
- Add test coverage for untested modules or edge cases
- Reproduce and confirm reported bugs with a minimal repro
- Improve test reliability across Python versions and platforms
Community
- Answer questions in GitHub Issues and Discussions
- Review open pull requests with constructive feedback
- Share Semantica in blog posts, talks, or conference demos
Development Setup
git clone https://github.com/your-username/semantica.git
cd semantica
pip install -e ".[dev]"
Code style tools:
pytest # full test suite
black semantica/ tests/ # auto-format
isort semantica/ tests/ # sort imports
flake8 semantica/ # lint
Style conventions: Black for formatting, isort for imports, flake8 for linting. All three run in CI.
Reporting Issues
Bug reports should include:
- What happened vs. what you expected
- Minimal steps to reproduce
- Your environment: Python version, OS, Semantica version (
python -c "import semantica; print(semantica.__version__)")
Feature requests should include:
- Your concrete use case
- What you'd like Semantica to do
- Why it benefits a broad set of users, not just your specific workflow
Pull Request Checklist
Before submitting a PR, confirm:
- Tests pass locally —
pytest - New features include documentation with working code examples
- Code follows project style — Black, isort, flake8
- Commit messages are clear and describe the why, not just the what
- No unresolved merge conflicts
Code of Conduct
All contributors are expected to follow the Contributor Covenant Code of Conduct. Be respectful, patient, and constructive — especially toward newcomers. Report violations by opening an issue with the [CoC] prefix.