Skip to content

Commit 6655d7a

Browse files
lhassa8claude
andcommitted
docs: Update README and CONTRIBUTING with new resources
README.md: - Add Examples & Tutorials section with links - Expand Resources section with community links - Add links to Roadmap, Discussions, Security, CoC CONTRIBUTING.md: - Link to Code of Conduct - Add examples directory to project structure - Update documentation guidelines Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 3da3d51 commit 6655d7a

2 files changed

Lines changed: 39 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for your interest in contributing to SkillForge! This document provide
44

55
## Code of Conduct
66

7-
Please be respectful and constructive in all interactions. We're building something together.
7+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful and constructive in all interactions.
88

99
## Getting Started
1010

@@ -164,7 +164,14 @@ skillforge/
164164
│ ├── test_analytics.py
165165
│ ├── test_config.py
166166
│ └── test_migrate.py
167-
└── skills/ # Example/generated skills
167+
├── examples/ # Examples and tutorials
168+
│ ├── skills/ # Example skills
169+
│ │ ├── code-reviewer/
170+
│ │ ├── git-commit/
171+
│ │ ├── api-documenter/
172+
│ │ └── data-analyst/
173+
│ └── tutorials/ # Step-by-step guides
174+
└── skills/ # Generated skills (gitignored)
168175
```
169176

170177
## Testing Guidelines
@@ -195,7 +202,9 @@ class TestFeatureName:
195202
- Update README.md for user-facing features
196203
- Add docstrings to public functions
197204
- Include examples in docstrings
198-
- Update CHANGELOG.md
205+
- Update CHANGELOG.md for releases
206+
- Update ROADMAP.md for planned features
207+
- Add tutorials in `examples/tutorials/` for complex features
199208

200209
## Release Process
201210

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1486,12 +1486,36 @@ MIT License - see [LICENSE](LICENSE) for details.
14861486

14871487
---
14881488

1489+
## Examples & Tutorials
1490+
1491+
Get started quickly with our examples and step-by-step tutorials:
1492+
1493+
- [Examples](examples/) - Sample skills demonstrating various features
1494+
- [Tutorial 1: Getting Started](examples/tutorials/01-getting-started.md) - Create your first skill
1495+
- [Tutorial 2: Testing Skills](examples/tutorials/02-testing-skills.md) - Write and run tests
1496+
- [Tutorial 3: Security & Governance](examples/tutorials/03-security-governance.md) - Secure your skills
1497+
- [Tutorial 4: Multi-Platform Publishing](examples/tutorials/04-multi-platform.md) - Deploy everywhere
1498+
- [Tutorial 5: MCP Integration](examples/tutorials/05-mcp-integration.md) - Expose skills as MCP tools
1499+
1500+
---
1501+
14891502
## Resources
14901503

1504+
**Documentation:**
1505+
- [Examples & Tutorials](examples/)
1506+
- [Changelog](CHANGELOG.md)
1507+
- [Roadmap](ROADMAP.md)
1508+
- [Contributing Guide](CONTRIBUTING.md)
1509+
1510+
**External:**
14911511
- [Anthropic Agent Skills Documentation](https://docs.anthropic.com/en/docs/agents-and-tools/agent-skills)
14921512
- [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
1493-
- [Changelog](CHANGELOG.md)
1513+
1514+
**Community:**
1515+
- [GitHub Discussions](https://github.com/lhassa8/skillforge/discussions)
14941516
- [Issue Tracker](https://github.com/lhassa8/skillforge/issues)
1517+
- [Security Policy](SECURITY.md)
1518+
- [Code of Conduct](CODE_OF_CONDUCT.md)
14951519

14961520
---
14971521

@@ -1501,6 +1525,8 @@ Current version: **1.0.0**
15011525

15021526
SkillForge follows [Semantic Versioning](https://semver.org/). The public API (exported from `skillforge.api`) is stable and will not have breaking changes in minor versions.
15031527

1528+
See our [Roadmap](ROADMAP.md) for upcoming features.
1529+
15041530
---
15051531

15061532
<p align="center">

0 commit comments

Comments
 (0)