Contributing

How to contribute to Smart Shelf development

Contributing to Smart Shelf

Welcome to the Smart Shelf contributor community! We're excited to have you join us in building an amazing inventory management platform. This documentation hub will guide you through our contribution process and help you get started.

Quick Start

New to contributing? Start with these essential guides:

Development Setup

Set up your local development environment and tools

Code Standards

Follow our coding conventions and best practices

Development Workflow

Understand our git workflow and contribution process

Community Guidelines

Learn about our community standards and values

Development Process

Essential Development Guides

🛠️ Development Setup

Environment setup, prerequisites, and local development configuration

📝 Code Standards

TypeScript, React, and coding conventions for consistent development

🔄 Development Workflow

Git workflow, branching strategy, and commit conventions

🧪 Testing Guidelines

Testing standards, frameworks, and best practices

Quality & Documentation

📚 Documentation Standards

Writing and maintaining high-quality documentation

🔀 Pull Request Process

Creating, reviewing, and merging pull requests

🐛 Issue Reporting

Reporting bugs, requesting features, and issue templates

🔒 Security Guidelines

Secure development practices and vulnerability reporting

Community & Support

👥 Community Guidelines

Community standards, code of conduct, and collaboration

Contribution Types

Code Contributions

  • Frontend Development: React components, UI/UX improvements, accessibility features
  • Backend Development: API endpoints, database schemas, business logic implementation
  • Testing: Unit tests, integration tests, end-to-end testing suites
  • Performance: Optimization, monitoring tools, scalability improvements

Non-Code Contributions

  • Documentation: Writing guides, API documentation, tutorials, and examples
  • Design: UI mockups, user experience improvements, design system updates
  • Community: Helping others, organizing events, mentoring new contributors
  • Quality Assurance: Manual testing, bug reports, user feedback collection

First Time Contributors

Looking for your first contribution? Check out issues labeled with:

  • good first issue - Perfect for newcomers to the project
  • help wanted - Community assistance needed
  • documentation - Help improve our documentation
  • frontend - UI/UX improvements and React development
  • backend - API and server-side development

Support Channels

Getting Help

  • 📖 Documentation: Start with our comprehensive guides
  • 💬 GitHub Discussions: Join community conversations and ask questions
  • 🐛 GitHub Issues: Report bugs or request features
  • ✉️ Direct Contact: Reach out to maintainers for complex issues

Security

For security vulnerabilities, please email: security@smartshelf.com
Do not report security issues in public GitHub issues.

Ready to contribute? Start with our Development Setup guide to get your environment ready, then explore the specific areas you're interested in contributing to.