Contributing Guidelines

We welcome contributions to the Inventory Management UI! This document provides guidelines for contributing to the project.

๐Ÿš€ Getting Started

1. Fork and Clone

# Fork the repository on GitHub, then clone your fork
git clone https://github.com/YOUR-USERNAME/inventory-management-ui.git
cd inventory-management-ui

# Add the original repository as upstream
git remote add upstream https://github.com/ORIGINAL-OWNER/inventory-management-ui.git

2. Set Up Development Environment

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env
# Edit .env with your configuration

# Start development server
npm run dev

๐Ÿ“‹ Essential Guidelines

Before contributing, please review our development guidelines:

๐Ÿ“– Coding Guidelines

๐Ÿงช Testing Guidelines

๐Ÿ”— API Integration Guidelines

๐Ÿ“ Contribution Process

1. Create a Feature Branch

# Create and switch to a new branch
git checkout -b feature/your-feature-name

# Or for bug fixes
git checkout -b fix/bug-description

2. Make Your Changes

3. Commit Your Changes

We follow Conventional Commits:

# Examples of good commit messages
git commit -m "feat: add tag management to item detail view"
git commit -m "fix: resolve routing issue with detail views"
git commit -m "docs: update API integration documentation"
git commit -m "test: add unit tests for auth store"

4. Push and Create Pull Request

# Push your branch
git push origin feature/your-feature-name

Option A: Using GitHub Web Interface

  1. Navigate to your fork on GitHub
  2. Click โ€œCompare & pull requestโ€
  3. Provide a clear title and description
  4. Reference any related issues
  5. Wait for code review
# Install GitHub CLI
# Windows: choco install gh
# macOS: brew install gh
# Linux: sudo apt install gh

# Authenticate (one-time setup)
gh auth login

# Create PR with auto-merge and squash
gh pr create --title "feat: add new feature" --body "Description of changes" \
  --assignee @me \
  --label "enhancement" \
  --auto-merge \
  --squash

โœ… Pre-Submission Checklist

Before submitting your PR, ensure youโ€™ve followed our guidelines:

Code Quality

Testing

Documentation

Git

๐Ÿ” Code Review Process

What We Look For

  1. Code Quality
  2. Testing
  3. Performance
    • No unnecessary re-renders
    • Efficient API calls
    • Proper loading states
  4. Accessibility
    • Semantic HTML
    • Proper ARIA labels
    • Keyboard navigation support

๐ŸŽฏ Areas for Contribution

We especially welcome contributions in these areas:

๐Ÿ“ž Getting Help

For technical questions about our development practices, please refer to our guidelines section.

๐Ÿ† Recognition

Contributors will be recognized in:

Thank you for contributing to the Inventory Management UI! ๐ŸŽ‰


Last updated: July 09, 2025

Local Development: This is a basic layout for local Jekyll development. When deployed to GitHub Pages, this site will use the just-the-docs theme.