diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..6febeebbe7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to Clawdis + +Welcome to the lobster tank! 🦞 + +## Quick Links +- **GitHub:** https://github.com/steipete/clawdis +- **Discord:** https://discord.gg/qkhbAGHRBT +- **X/Twitter:** [@steipete](https://x.com/steipete) / [@clawdbot](https://x.com/clawdbot) + +## Maintainers + +- **Peter Steinberger** - Benevolent Dictator + - GitHub: [@steipete](https://github.com/steipete) · X: [@steipete](https://x.com/steipete) + +- **Shadow** - Discord subsystem + - GitHub: [@4shadowed](https://github.com/4shadowed) · X: [@4shad0wed](https://x.com/4shad0wed) + +- **Jos** - Telegram, API, Nix mode + - GitHub: [@joshp123](https://github.com/joshp123) · X: [@jjpcodes](https://x.com/jjpcodes) + +## How to Contribute +1. **Bugs & small fixes** → Open a PR! +2. **New features / architecture** → Start a [GitHub Discussion](https://github.com/steipete/clawdis/discussions) or ask in Discord first +3. **Questions** → Discord #setup-help + +## Before You PR +- Test locally with your Clawdis instance +- Run linter: `npm run lint` +- Keep PRs focused (one thing per PR) +- Describe what & why + +## AI/Vibe-Coded PRs Welcome! 🤖 + +Built with Codex, Claude, or other AI tools? **Awesome - just mark it!** + +Please include in your PR: +- [ ] Mark as AI-assisted in the PR title or description +- [ ] Note the degree of testing (untested / lightly tested / fully tested) +- [ ] Include prompts or session logs if possible (super helpful!) +- [ ] Confirm you understand what the code does + +AI PRs are first-class citizens here. We just want transparency so reviewers know what to look for. diff --git a/README.md b/README.md index c7388a05d90..2b4067bd354 100644 --- a/README.md +++ b/README.md @@ -231,6 +231,12 @@ clawdis hooks gmail run - [`docs/ios/connect.md`](docs/ios/connect.md) - [`docs/clawdis-mac.md`](docs/clawdis-mac.md) +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines, maintainers, and how to submit PRs. + +AI/vibe-coded PRs welcome! 🤖 + ## Clawd Clawdis was built for **Clawd**, a space lobster AI assistant.