Skip to content

Commit 535b4b4

Browse files
grasberggrasberg
committed
feat: overhaul README, add landing page, docs, community files, and security policy
1 parent 6bfc958 commit 535b4b4

18 files changed

Lines changed: 4363 additions & 593 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
1-
---
2-
name: Bug Report
3-
about: Report a bug to help improve Sofia
4-
title: "[Bug] "
5-
labels: bug
6-
assignees: ''
7-
---
1+
# Bug Report
82

9-
## Describe the bug
3+
## Description
4+
A clear and concise description of the bug.
105

11-
A clear, concise description of what the bug is.
6+
## Steps to Reproduce
7+
1. Go to '...'
8+
2. Run command '...'
9+
3. See error
1210

13-
## Steps to reproduce
11+
## Expected Behavior
12+
A clear description of what you expected to happen.
1413

15-
1. Run `...`
16-
2. Navigate to `...`
17-
3. See error
14+
## Actual Behavior
15+
A clear description of what actually happened.
1816

19-
## Expected behavior
17+
## Environment
18+
- **Sofia version**: [e.g., v0.0.145]
19+
- **OS**: [e.g., macOS 14.4, Ubuntu 22.04]
20+
- **Go version**: [e.g., 1.26.0]
21+
- **LLM provider**: [e.g., OpenAI, Claude, Gemini]
2022

21-
What you expected to happen.
23+
## Configuration
24+
<details>
25+
<summary>config.json (redacted)</summary>
2226

23-
## Actual behavior
27+
```json
28+
// Paste your config.json here (remove API keys!)
29+
```
2430

25-
What actually happened. Include any error messages or logs.
31+
</details>
2632

27-
## Environment
33+
## Logs
34+
<details>
35+
<summary>Relevant log output</summary>
2836

29-
- **OS:** (e.g., macOS 15, Ubuntu 24.04)
30-
- **Go version:** (e.g., 1.26)
31-
- **Sofia version:** (e.g., v0.0.145)
32-
- **LLM provider:** (e.g., OpenAI, Anthropic)
37+
```
38+
// Paste relevant log output here
39+
```
3340

34-
## Additional context
41+
</details>
3542

36-
Add any other context, screenshots, or log output here.
43+
## Additional Context
44+
Any other context about the problem, screenshots, etc.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
1-
---
2-
name: Feature Request
3-
about: Suggest a new feature or improvement for Sofia
4-
title: "[Feature] "
5-
labels: enhancement
6-
assignees: ''
7-
---
1+
# Feature Request
82

9-
## Problem or motivation
10-
11-
Describe the problem you're trying to solve or the motivation behind this feature.
12-
13-
## Proposed solution
3+
## Problem Statement
4+
A clear description of the problem or limitation you're facing.
145

6+
## Proposed Solution
157
A clear description of what you'd like to happen.
168

17-
## Alternatives considered
18-
19-
Any alternative solutions or features you've considered.
9+
## Alternatives Considered
10+
A description of any alternative solutions or features you've considered.
2011

21-
## Additional context
12+
## Additional Context
13+
Any other context, screenshots, or references that help explain the request.
2214

23-
Add any other context, mockups, or examples here.
15+
## Would You Be Willing to Implement This?
16+
- [ ] Yes, I'd like to submit a PR for this feature

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Question / Support
2+
3+
## What would you like to know?
4+
A clear description of your question.
5+
6+
## What have you tried?
7+
What steps have you already taken to find an answer?
8+
9+
## Environment
10+
- **Sofia version**: [e.g., v0.0.145]
11+
- **OS**: [e.g., macOS 14.4]
12+
- **LLM provider**: [e.g., OpenAI]
13+
14+
## Additional Context
15+
Any other context that might help answer your question.

‎.github/pull_request_template.md‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
1-
## What does this PR do?
1+
# Pull Request
22

3-
A brief description of the change.
3+
## Description
4+
A clear description of the changes in this PR.
45

5-
## Why?
6+
## Type of Change
7+
- [ ] Bug fix (non-breaking change that fixes an issue)
8+
- [ ] New feature (non-breaking change that adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
- [ ] Performance improvement
12+
- [ ] Code refactoring
613

7-
Explain the motivation — what problem does this solve?
14+
## How Has This Been Tested?
15+
Describe the tests you ran to verify your changes.
816

9-
## How to test
10-
11-
Steps to verify this change works correctly.
17+
- [ ] Unit tests pass: `make test`
18+
- [ ] Manual testing performed
19+
- [ ] New tests added for new functionality
1220

1321
## Checklist
22+
- [ ] My code follows the project's style guidelines
23+
- [ ] I have performed a self-review of my code
24+
- [ ] I have commented my code, particularly in hard-to-understand areas
25+
- [ ] I have made corresponding changes to the documentation
26+
- [ ] My changes generate no new warnings
27+
- [ ] I have added tests that prove my fix is effective or that my feature works
28+
- [ ] New and existing unit tests pass locally with my changes
1429

15-
- [ ] Code builds cleanly (`make build`)
16-
- [ ] Changes are focused on a single concern
17-
- [ ] README or docs updated (if applicable)
30+
## Related Issues
31+
Closes #(issue number)

‎CODE_OF_CONDUCT.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

‎CONTRIBUTING.md‎

Lines changed: 64 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,93 @@
11
# Contributing to Sofia
22

3-
Thanks for your interest in contributing to Sofia! Whether it's a bug report, feature idea, documentation improvement, or code contribution — every bit helps.
3+
First off, thank you for considering contributing to Sofia! It's people like you that make Sofia such a great tool.
44

5-
## Getting Started
5+
## 🚀 Quick Start
66

7-
1. **Fork** the repository and clone your fork:
8-
```bash
9-
git clone https://github.com/YOUR_USERNAME/sofia.git
10-
cd sofia
11-
```
7+
1. **Fork** the repository
8+
2. **Clone** your fork: `git clone https://github.com/YOUR_USERNAME/sofia.git`
9+
3. **Create a branch**: `git checkout -b my-feature`
10+
4. **Make changes** and commit: `git commit -m "Add my feature"`
11+
5. **Push**: `git push origin my-feature`
12+
6. **Open a Pull Request**
1213

13-
2. **Install dependencies and build:**
14-
```bash
15-
make deps
16-
make build
17-
```
14+
## 🛠️ Development Setup
1815

19-
3. **Run Sofia locally:**
20-
```bash
21-
./build/sofia onboard # First time only
22-
./build/sofia gateway
23-
```
16+
```bash
17+
git clone https://github.com/grasberg/sofia.git
18+
cd sofia
19+
make deps && make build
20+
make test
21+
```
2422

25-
4. **Create a branch** for your change:
26-
```bash
27-
git checkout -b my-feature
28-
```
23+
**Prerequisites:** Go 1.26+
2924

30-
## How to Contribute
25+
## 📝 Commit Conventions
3126

32-
### Reporting Bugs
27+
We follow [Conventional Commits](https://www.conventionalcommits.org/):
3328

34-
Open a [bug report](https://github.com/grasberg/sofia/issues/new?template=bug_report.md) with:
35-
- What you expected to happen
36-
- What actually happened
37-
- Steps to reproduce
38-
- Your Go version and OS
29+
- `feat:` New feature
30+
- `fix:` Bug fix
31+
- `docs:` Documentation changes
32+
- `style:` Code style changes (formatting, etc.)
33+
- `refactor:` Code refactoring
34+
- `test:` Adding or updating tests
35+
- `chore:` Build process or auxiliary tool changes
3936

40-
### Suggesting Features
37+
## 🧪 Testing
4138

42-
Open a [feature request](https://github.com/grasberg/sofia/issues/new?template=feature_request.md) describing your idea and why it would be useful.
39+
Run the full test suite:
4340

44-
### Submitting Code
41+
```bash
42+
make test
43+
```
4544

46-
1. Make sure your code builds cleanly (`make build`)
47-
2. Follow the existing code style — Sofia is written in idiomatic Go
48-
3. Keep commits focused — one logical change per commit
49-
4. Write a clear PR description explaining *what* and *why*
45+
Run tests for a specific package:
5046

51-
### Improving Documentation
47+
```bash
48+
go test ./pkg/yourpackage/...
49+
```
5250

53-
Documentation improvements are always welcome. If you spot a typo, unclear instruction, or missing info — feel free to open a PR.
51+
## 📋 Pull Request Process
5452

55-
## Code Structure
53+
1. Ensure all tests pass: `make test`
54+
2. Update documentation if needed
55+
3. Add tests for new features
56+
4. Keep PRs focused — one feature per PR
57+
5. Write a clear description of your changes
58+
59+
## 🏗️ Project Structure
5660

5761
```
5862
sofia/
59-
├── cmd/ # CLI entry points
63+
├── cmd/ # Command-line interface
6064
├── pkg/ # Core packages
61-
├── assets/ # Static web UI assets
62-
├── docs/ # Documentation
63-
├── workspace/ # Default workspace templates
64-
├── Makefile # Build targets
65+
│ ├── agent/ # Agent orchestration
66+
│ ├── llm/ # LLM provider abstraction
67+
│ ├── memory/ # Memory and knowledge graph
68+
│ ├── skills/ # Skill system
69+
│ ├── tools/ # Built-in tools
70+
│ └── gateway/ # Web UI and API
71+
├── workspace/ # Default workspace files
72+
├── Makefile # Build and test commands
6573
└── go.mod # Go module definition
6674
```
6775

68-
## Good First Issues
76+
## 💡 Ways to Contribute
77+
78+
- **Bug reports** — Found a bug? Open an issue!
79+
- **Feature requests** — Have an idea? We'd love to hear it.
80+
- **Documentation** — Help improve our docs
81+
- **Code** — Fix bugs, add features, improve performance
82+
- **Skills** — Create and share new skills via ClawHub
83+
- **Reviews** — Review open PRs
6984

70-
Look for issues labeled [`good first issue`](https://github.com/grasberg/sofia/labels/good%20first%20issue) — these are specifically chosen to be approachable for new contributors.
85+
## 🤝 Code of Conduct
7186

72-
## Questions?
87+
This project adheres to the [Contributor Covenant](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
7388

74-
Open a [Discussion](https://github.com/grasberg/sofia/discussions) or file an issue — happy to help.
89+
## ❓ Questions?
7590

76-
---
91+
Open a [Discussion](https://github.com/grasberg/sofia/discussions) — we're happy to help!
7792

78-
Thank you for helping make Sofia better!
93+
Thank you for contributing! 🎉

0 commit comments

Comments
 (0)