mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-08-29 04:26:20 +00:00
docs: remove email addresses and add discussion templates
- Remove email addresses from support, security, contributing, and community docs - Replace email contacts with GitHub Issues and Security Advisories - Add discussion templates for Q&A, Ideas, Showcase, and General discussions - Update SUPPORT.md with Discussions section
This commit is contained in:
KaifAhmad1
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "[GENERAL] "
|
||||
labels: ["general"]
|
||||
---
|
||||
|
||||
## Discussion Topic
|
||||
|
||||
What would you like to discuss? Provide a clear topic or question.
|
||||
|
||||
## Details
|
||||
|
||||
Provide context, background, or details about your discussion topic. This could be about Semantica, the community, best practices, architecture, use cases, etc.
|
||||
|
||||
## Discussion Areas
|
||||
|
||||
What aspects would you like to discuss or get opinions on?
|
||||
|
||||
- [ ] Best practices
|
||||
- [ ] Architecture / Design
|
||||
- [ ] Use cases
|
||||
- [ ] Community
|
||||
- [ ] Roadmap / Future
|
||||
- [ ] Other:
|
||||
|
||||
## Your Thoughts
|
||||
|
||||
Share your thoughts, questions, or opinions.
|
||||
|
||||
## Questions for the Community
|
||||
|
||||
What would you like to hear from others?
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: "[IDEA] "
|
||||
labels: ["idea", "enhancement"]
|
||||
---
|
||||
|
||||
## Idea Summary
|
||||
|
||||
Provide a brief, clear summary of your idea (1-2 sentences).
|
||||
|
||||
## Problem Statement
|
||||
|
||||
What problem or limitation does this idea address? Be specific about the pain points.
|
||||
|
||||
## Detailed Description
|
||||
|
||||
Describe your idea in detail. What would it do? How would it work?
|
||||
|
||||
## Use Cases
|
||||
|
||||
Describe specific scenarios where this would be useful:
|
||||
|
||||
1. **Use Case 1**:
|
||||
- Who would use it?
|
||||
- What would they do?
|
||||
- What benefit would they get?
|
||||
|
||||
2. **Use Case 2**:
|
||||
- Who would use it?
|
||||
- What would they do?
|
||||
- What benefit would they get?
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
Have you considered any alternative approaches? Why is your idea better?
|
||||
|
||||
- **Alternative 1**:
|
||||
- Why it doesn't work:
|
||||
|
||||
- **Alternative 2**:
|
||||
- Why it doesn't work:
|
||||
|
||||
## Examples / References
|
||||
|
||||
- Similar features in other projects:
|
||||
- Code examples:
|
||||
```python
|
||||
# Example of how it might work
|
||||
```
|
||||
- Links:
|
||||
|
||||
## Impact Assessment
|
||||
|
||||
- Who would benefit:
|
||||
- Priority: [ ] Low [ ] Medium [ ] High [ ] Critical
|
||||
- Breaking Changes: [ ] Yes [ ] No
|
||||
- If yes, describe:
|
||||
- Dependencies:
|
||||
|
||||
## Implementation Ideas
|
||||
|
||||
If you have ideas on how this could be implemented, please share.
|
||||
|
||||
## Contribution
|
||||
|
||||
- [ ] I'm willing to help implement this
|
||||
- [ ] I can help with documentation
|
||||
- [ ] I can help with testing
|
||||
- [ ] I can provide use cases or examples
|
||||
|
||||
---
|
||||
|
||||
**Note**: For feature requests that are ready to be implemented, consider creating a [Feature Request issue](https://github.com/Hawksight-AI/semantica/issues/new?template=feature_request.md) instead.
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: "[Q&A] "
|
||||
labels: ["question", "help wanted"]
|
||||
---
|
||||
|
||||
## Question
|
||||
|
||||
Please provide a clear and detailed question. Be specific about what you're trying to accomplish.
|
||||
|
||||
## Objective
|
||||
|
||||
Describe your end goal or what you're trying to achieve.
|
||||
|
||||
## Attempts
|
||||
|
||||
List the steps you have already taken to solve this problem:
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Code Example
|
||||
|
||||
If your question involves code, please share a minimal, reproducible example:
|
||||
|
||||
```python
|
||||
from semantica import Semantica
|
||||
|
||||
# Your code here
|
||||
```
|
||||
|
||||
## Error Messages
|
||||
|
||||
If applicable, paste any error messages or describe unexpected behavior:
|
||||
|
||||
```
|
||||
# Paste error messages here
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
- Python version:
|
||||
- Semantica version:
|
||||
- OS:
|
||||
- Relevant dependencies:
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] I have searched existing [discussions](https://github.com/Hawksight-AI/semantica/discussions) and [issues](https://github.com/Hawksight-AI/semantica/issues)
|
||||
- [ ] I have checked the [documentation](https://github.com/Hawksight-AI/semantica/tree/main/docs) and [FAQ](https://github.com/Hawksight-AI/semantica/blob/main/docs/faq.md)
|
||||
- [ ] I have provided a minimal code example (if applicable)
|
||||
- [ ] I have included error messages (if applicable)
|
||||
- [ ] I have provided environment details
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: "[SHOWCASE] "
|
||||
labels: ["showcase", "community"]
|
||||
---
|
||||
|
||||
## Project Summary
|
||||
|
||||
Provide a brief summary of your project (1-2 sentences).
|
||||
|
||||
## Description
|
||||
|
||||
### Functionality
|
||||
|
||||
Describe the functionality and purpose of your project.
|
||||
|
||||
### Semantica Features Used
|
||||
|
||||
- [ ] Data Ingestion
|
||||
- [ ] Entity Extraction
|
||||
- [ ] Relationship Extraction
|
||||
- [ ] Knowledge Graph Construction
|
||||
- [ ] Ontology Generation
|
||||
- [ ] GraphRAG
|
||||
- [ ] Agent Memory
|
||||
- [ ] Pipeline Orchestration
|
||||
- [ ] Quality Assurance
|
||||
- [ ] Other:
|
||||
|
||||
### Challenges Solved
|
||||
|
||||
Describe the problems you solved or the value you created.
|
||||
|
||||
### Results
|
||||
|
||||
Share any interesting findings, metrics, or outcomes.
|
||||
|
||||
## Links
|
||||
|
||||
- Project URL:
|
||||
- Repository:
|
||||
- Live Demo:
|
||||
- Blog Post / Article:
|
||||
- Documentation:
|
||||
|
||||
## Code Example
|
||||
|
||||
```python
|
||||
# Your code here
|
||||
# Show how you used Semantica
|
||||
```
|
||||
|
||||
## Screenshots / Media
|
||||
|
||||
Share screenshots, diagrams, or other visual content. You can drag and drop images directly into this discussion.
|
||||
|
||||
## Lessons Learned
|
||||
|
||||
### What worked well?
|
||||
|
||||
### What would you do differently?
|
||||
|
||||
### Tips for others:
|
||||
|
||||
## Future Plans
|
||||
|
||||
What's next for this project?
|
||||
|
||||
## Metrics / Results (optional)
|
||||
|
||||
- Performance:
|
||||
- Accuracy:
|
||||
- Other metrics:
|
||||
|
||||
## Permissions
|
||||
|
||||
- [ ] I'm okay with this being featured in community showcases
|
||||
- [ ] Others can use my code as a reference
|
||||
- [ ] I'm open to questions and collaboration
|
||||
|
||||
+9
-2
@@ -9,6 +9,13 @@ Check the [docs folder](https://github.com/Hawksight-AI/semantica/tree/main/docs
|
||||
- **GitHub Discussions**: [Ask questions](https://github.com/Hawksight-AI/semantica/discussions)
|
||||
- **Discord**: Join our [Discord server](https://discord.gg/semantica) for real-time chat
|
||||
|
||||
### 💭 Discussions
|
||||
Join the conversation on [GitHub Discussions](https://github.com/Hawksight-AI/semantica/discussions):
|
||||
- **Q&A**: Ask questions and get help from the community
|
||||
- **Ideas**: Share feature requests and suggestions
|
||||
- **Show and Tell**: Showcase your projects and use cases
|
||||
- **General**: General discussions about Semantica
|
||||
|
||||
### 🐛 Bug Reports
|
||||
Found a bug? [Create an issue](https://github.com/Hawksight-AI/semantica/issues/new/choose)
|
||||
|
||||
@@ -20,8 +27,8 @@ Found a bug? [Create an issue](https://github.com/Hawksight-AI/semantica/issues/
|
||||
## Commercial Support
|
||||
|
||||
For enterprise support, custom development, or consulting services:
|
||||
- Email: semantica-dev@users.noreply.github.com
|
||||
- Include "Commercial Support" in the subject line
|
||||
- Contact us through [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues)
|
||||
- Include "Commercial Support" in the title
|
||||
|
||||
## Sponsorship
|
||||
|
||||
|
||||
+2
-2
@@ -57,8 +57,8 @@ representative at an online or offline event.
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
semantica-dev@users.noreply.github.com.
|
||||
reported to the community leaders responsible for enforcement through
|
||||
[GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) with "[CoC]" prefix.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
|
||||
@@ -364,7 +364,6 @@ def extract_entities(
|
||||
- **GitHub Discussions**: General questions and discussions
|
||||
- **GitHub Issues**: Bug reports and feature requests
|
||||
- **Discord**: Real-time chat and community support
|
||||
- **Email**: semantica-dev@users.noreply.github.com
|
||||
|
||||
### Before Asking for Help
|
||||
|
||||
|
||||
@@ -499,7 +499,7 @@ print(f"Answer: {result.answer} | Nodes: {kg.node_count}, Edges: {kg.edge_count}
|
||||
| **Enterprise** | 24/7 support | 4h | Contact |
|
||||
| **Premium** | Phone, custom dev | 1h | Contact |
|
||||
|
||||
**Contact:** enterprise@semantica.io
|
||||
**Contact:** [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) with "[Enterprise]" prefix
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
|
||||
+4
-4
@@ -17,9 +17,9 @@ We take security vulnerabilities seriously. If you discover a security vulnerabi
|
||||
|
||||
Security vulnerabilities should be reported privately to prevent potential exploitation.
|
||||
|
||||
### 2. Email Security Team
|
||||
### 2. Report Security Issue
|
||||
|
||||
Send an email to: **semantica-dev@users.noreply.github.com**
|
||||
Create a [GitHub Security Advisory](https://github.com/Hawksight-AI/semantica/security/advisories/new) or contact us through [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) with "[SECURITY]" prefix.
|
||||
|
||||
Include the following information:
|
||||
|
||||
@@ -151,8 +151,8 @@ We appreciate responsible disclosure. Security researchers who help us improve t
|
||||
|
||||
For security-related questions or concerns:
|
||||
|
||||
- **Email**: semantica-dev@users.noreply.github.com
|
||||
- **Subject**: [SECURITY] Brief description
|
||||
- **GitHub Issues**: [Create an issue](https://github.com/Hawksight-AI/semantica/issues) with "[SECURITY]" prefix
|
||||
- **GitHub Security Advisories**: [Report vulnerability](https://github.com/Hawksight-AI/semantica/security/advisories/new)
|
||||
|
||||
## Additional Resources
|
||||
|
||||
|
||||
+3
-3
@@ -17,8 +17,8 @@ Welcome to the Semantica community!
|
||||
|
||||
### Contact
|
||||
|
||||
- **Email**: semantica-dev@users.noreply.github.com (for security issues)
|
||||
- **GitHub**: Preferred for all other communication
|
||||
- **GitHub Issues**: [Create an issue](https://github.com/Hawksight-AI/semantica/issues) for all communication
|
||||
- **GitHub Security Advisories**: [Report security issues](https://github.com/Hawksight-AI/semantica/security/advisories/new)
|
||||
|
||||
---
|
||||
|
||||
@@ -40,7 +40,7 @@ We have a [Code of Conduct](https://github.com/Hawksight-AI/semantica/blob/main/
|
||||
|
||||
If you experience unacceptable behavior:
|
||||
1. Document what happened
|
||||
2. Contact maintainers at semantica-dev@users.noreply.github.com
|
||||
2. Contact maintainers through [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) with "[CoC]" prefix
|
||||
3. We'll investigate and respond appropriately
|
||||
|
||||
---
|
||||
|
||||
+2
-2
@@ -72,7 +72,7 @@ Project governance model for Semantica.
|
||||
|
||||
- **GitHub Issues**: Bug reports, features, questions
|
||||
- **GitHub PRs**: Code contributions
|
||||
- **Email**: semantica-dev@users.noreply.github.com (security only)
|
||||
- **GitHub Security Advisories**: [Report security issues](https://github.com/Hawksight-AI/semantica/security/advisories/new)
|
||||
|
||||
---
|
||||
|
||||
@@ -92,4 +92,4 @@ MIT License - See [LICENSE](https://github.com/Hawksight-AI/semantica/blob/main/
|
||||
|
||||
---
|
||||
|
||||
**Contact**: [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) or semantica-dev@users.noreply.github.com
|
||||
**Contact**: [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues)
|
||||
|
||||
Reference in New Issue
Block a user