Contributing to Scry
Thank you for your interest in contributing to Scry!
Ways to Contribute
- Report bugs - File issues for problems you encounter
- Suggest features - Propose new features or improvements
- Improve documentation - Fix typos, add examples, clarify explanations
- Submit code - Fix bugs or implement new features
- Help others - Answer questions in discussions
Getting Started
- Read the documentation - Understand how Scry works
- Set up your environment - Follow the Development Setup
- Find an issue - Look for
good first issuelabels - Make changes - Follow our Code Style
- Submit a PR - Follow the Pull Request process
Repository Structure
Scry consists of multiple repositories:
| Repository | Description |
|---|---|
scry-node | CLI tool (@scry/storybook-deployer) |
scry-storybook-upload-service | Upload Service (Cloudflare Worker) |
scry-cdn-service | CDN Service (Cloudflare Worker) |
scry-developer-dashboard | Dashboard (Next.js) |
Quick Links
- Development Setup - Set up local environment
- Code Style - Coding conventions
- Testing - Writing and running tests
- Pull Requests - PR guidelines
- Architecture - System design
Code of Conduct
We follow the Contributor Covenant.
Expected behavior:
- Be respectful and inclusive
- Accept constructive criticism
- Focus on what's best for the community
- Show empathy towards others
Unacceptable behavior:
- Harassment or discrimination
- Trolling or insulting comments
- Publishing others' private information
- Other conduct inappropriate for a professional setting
Getting Help
- Questions: Open a Discussion
- Bugs: File an Issue
- Security: Email security@scry.com
Recognition
Contributors are recognized in:
- Release notes
- README contributors section
- Annual contributor highlights
Thank you for making Scry better!