Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
168 lines (106 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

168 lines (106 loc) · 2.94 KB
Raw

Contributing to Resto POS System

Thank you for your interest in contributing to the Resto POS System! This guide will help you understand how to contribute effectively and keep the project clean and maintainable.

Getting Started

1. Fork the Repository

Click the Fork button on GitHub and clone your fork:

git clone https://github.com/your-username/Resto-POS.git
cd Resto-POS

2. Create a Branch

Always create a new branch before making changes:

git checkout -b feature/your-feature-name

Branch naming conventions:

  • feature/... → New features
  • fix/... → Bug fixes
  • ui/... → UI improvements
  • refactor/... → Code improvements

Development Guidelines

Code Structure

  • Keep files organized (separate PHP, CSS, JS properly)
  • Follow existing project structure (src/, config/, etc.)
  • Avoid unnecessary file duplication

Coding Standards

  • Use clear and meaningful variable names
  • Keep code readable and consistent
  • Add comments where necessary (especially complex logic)
  • Avoid hardcoding values (use config when possible)

UI/UX Changes

  • Maintain responsiveness (mobile-friendly)
  • Keep design consistent with existing UI
  • Test layouts (no overflow, no broken alignment)

Database Changes

  • Clearly document any changes to database structure
  • Avoid breaking existing queries
  • Test with real data if possible

Before Submitting

Make sure you:

  • Tested your changes locally (XAMPP/MySQL)
  • No PHP errors or console errors
  • UI is responsive and clean
  • Code follows project structure
  • No unnecessary files included

Submitting a Pull Request

  1. Push your branch:
git push origin feature/your-feature-name

  1. Open a Pull Request on GitHub

  2. Include:

  • Clear description of changes
  • Screenshots (for UI updates)
  • Related issue (e.g. Closes #12)

Reporting Issues

When creating an issue, include:

  • Title: Short and clear
  • Description: What happened
  • Steps to reproduce
  • Expected behavior
  • Screenshots (if applicable)

Example:

Bug: Notification not updating in real-time

Steps:
1. Open dashboard
2. Create new order
3. Notification does not update

Expected:
Notification count should increase

Feature Requests

For new ideas:

  • Clearly explain the feature
  • Explain why it’s useful
  • (Optional) Suggest implementation

Security Guidelines

If you find a security issue:

  • Do NOT post it publicly
  • Report it privately to the maintainer

Contribution Rules

  • Keep commits clean and meaningful
  • Do not submit unrelated changes in one PR
  • Be respectful in discussions
  • Follow the Code of Conduct

Maintainer Notes

All contributions are reviewed before merging. The maintainer may request changes before approval.

Thank You

Your contributions help improve this system and make it more reliable and professional.

Let’s build something great together 🚀