Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 2.32 KB

File metadata and controls

79 lines (57 loc) · 2.32 KB

Contributing to Modern Mini Bank

First off, thank you for considering contributing to Modern Mini Bank! It's people like you that make this project better.

📋 Table of Contents

📜 Code of Conduct

Our Pledge

We pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Positive behavior includes:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Unacceptable behavior includes:

  • Trolling, insulting/derogatory comments, and personal attacks
  • Public or private harassment
  • Publishing others' private information without permission
  • Other conduct which could reasonably be considered inappropriate

🤝 How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues to avoid duplicates.

When submitting a bug report, include:

  • Clear and descriptive title
  • Exact steps to reproduce the problem
  • Expected behavior vs actual behavior
  • Screenshots if applicable
  • Your environment (PHP version, OS, browser)
  • Error messages or logs

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues.

When suggesting an enhancement, include:

  • Clear and descriptive title
  • Detailed description of the proposed functionality
  • Why this enhancement would be useful
  • Possible implementation approach

Pull Requests

  1. Fork the repo and create your branch from main
  2. Make your changes
  3. Test thoroughly
  4. Update documentation if needed
  5. Submit a pull request

🛠️ Development Setup

Prerequisites

  • PHP 8.3 or higher
  • Apache web server
  • Git
  • Code editor (VS Code, PHPStorm, etc.)

Local Setup