Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
192 lines (135 loc) · 6.09 KB

CONTRIBUTING.md

File metadata and controls

192 lines (135 loc) · 6.09 KB
CIN Framework Logo

CIN FRAMEWORK

CONTRIBUTING GUIDELINES

Official Website

Our Commitment

Thank you for your interest in contributing to CIN Framework! We welcome contributions from developers of all skill levels and are committed to maintaining the highest standards of code quality, security, and architectural integrity.

Code of Conduct

This project adheres to our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@cin-framework.com.

How to Contribute

Reporting Issues

  • Use our Reporting Guidelines for detailed instructions
  • Search existing issues before creating a new one
  • Provide clear, detailed descriptions with steps to reproduce
  • Include relevant system information and error messages
  • Use appropriate issue labels and templates

Suggesting Features

  • Open an issue with the "enhancement" label
  • Clearly describe the feature and its benefits
  • Explain how it aligns with CIN Framework's philosophy
  • Provide use cases and examples
  • Consider backward compatibility implications

Code Contributions

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your feature/fix
  4. Make your changes following our standards
  5. Test thoroughly across different environments
  6. Submit a pull request with detailed description

Development Standards

PHP Code (Backend)

  • Follow PSR-12 coding standards strictly
  • Use PHPDoc blocks for all classes, methods, and functions
  • No inline comments - documentation through PHPDoc only
  • Each file must include proper header with:
    • declare(strict_types=1); at the top
    • PHPDoc block with component name
    • @package CIN Framework
    • @author Ayoub Alarjani (MAWI MAN)
    • @license Proprietary - All rights reserved to CIN Framework
  • No external dependencies or Composer packages
  • Raw, native PHP solutions only

Frontend Code

  • Follow existing code style and patterns
  • Ensure cross-browser compatibility
  • Optimize for performance and accessibility
  • Test on mobile devices and various screen sizes
  • Use semantic HTML and modern CSS practices

General Guidelines

  • Write clear, self-documenting code
  • Include comprehensive tests for new functionality
  • Update documentation as needed
  • Ensure backward compatibility
  • Follow security best practices
  • Optimize for performance

Pull Request Process

  1. Before Submitting

    • Ensure your code follows our standards
    • Test your changes thoroughly
    • Update relevant documentation
    • Rebase your branch on the latest main
    • Run all existing tests

  2. Pull Request Requirements

    • Clear, descriptive title
    • Detailed description of changes
    • Reference related issues
    • Include screenshots for UI changes
    • List any breaking changes
    • Provide testing instructions

  3. Review Process

    • All PRs require review from maintainers
    • Address feedback promptly and professionally
    • Keep discussions constructive
    • Be patient - thorough reviews take time
    • Maintain code quality throughout iterations

Documentation

  • Keep documentation up-to-date with code changes
  • Use clear, concise, professional language
  • Include practical examples where helpful
  • Follow existing documentation style and structure
  • Ensure accuracy and completeness

Development Environment

Prerequisites

  • PHP 7.x or 8.x or higher
  • Web server (Apache/Nginx)
  • Modern web browser
  • Text editor or IDE with PHP support
  • Git for version control

Local Setup

  1. Clone the repository
  2. Set up your web server to serve the project
  3. Configure any necessary environment variables
  4. Test the setup by accessing the main page
  5. Verify all components are working correctly

Framework Management

For framework operations, use the official CIN CLI tool.

Security

For security-related issues, please follow our Security Policy. Do not report security vulnerabilities through public issues. Contact admin@cin-framework.com directly.

Recognition

Contributors will be recognized in:

  • Project documentation and release notes
  • Community acknowledgments
  • Significant contributions may be acknowledged in project credits
  • Annual contributor recognition program

Questions and Support

If you have questions about contributing:

Contact Information

Legal Information

Copyright © CIN FRAMEWORK. All Rights Reserved.

Developed by Ayoub Alarjani (Mawi Man) | Official Website Mawi Man: mawiman.com

By contributing to CIN Framework, you agree that your contributions will be licensed under the same proprietary license as the project. All contributions become part of the CIN Framework ecosystem and are subject to our licensing terms.

This contributing guide is governed by the laws of Morocco and is effective as of 2025.

Official Slogan: CIN FRAMEWORK – WEB 4 – POWERED BY LOCAL SELF-SUFFICIENCY AND AGGRESSIVE SECURITY