Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (71 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

107 lines (71 loc) · 2.6 KB
Raw

Contributing to ci4commonModel

Thank you for considering contributing to ci4commonModel!
This guide will help you understand the process and best practices when contributing to this project.

🚀 Getting Started

Before making any contributions, please ensure that you have:

  • Read the README to understand the purpose of the project.
  • Installed the required dependencies for CodeIgniter 4 development.
  • Familiarized yourself with the CodeIgniter 4 directory structure and best practices.

🧑‍💻 How to Contribute

There are many ways you can help:

  • Reporting bugs
  • Suggesting enhancements
  • Improving documentation
  • Submitting pull requests

🐛 Reporting Bugs

If you find a bug, please:

  1. Search the Issues to check if it’s already reported.
  2. If not, open a new issue using the Bug Report template.
  3. Include as much detail as possible:
    • Steps to reproduce
    • Expected vs. actual behavior
    • Version of CodeIgniter and PHP

✨ Suggesting Enhancements

When proposing a new feature:

  1. Open an issue using the Feature Request template.
  2. Clearly describe the problem and the proposed solution.
  3. Explain how the feature aligns with the scope of the project.

📂 Project Structure Notes

  • The project follows a modular approach. Avoid hard-coding paths or dependencies outside of CodeIgniter 4 standards.
  • Keep models clean, reusable, and context-agnostic.
  • Use PSR-12 coding style.

📥 Submitting a Pull Request

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/your-feature-name
  3. Make your changes.
  4. Run tests (if applicable).
  5. Commit with a meaningful message: 
    git commit -m "Add feature: Short description"
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Open a Pull Request on the main repo and describe your changes.

✅ Pull Request Requirements

  • Your code must pass CI and not break existing features.
  • Follow the project's coding conventions.
  • If you're fixing a bug or adding a feature, please include or update tests (if applicable).
  • Update documentation if needed.

🧪 Testing

If the project includes tests:

  • Run all tests before submitting your PR.
  • Prefer small, isolated changes to simplify review and merging.

🗣 Code of Conduct

Please read and follow our Code of Conduct.

🙏 Thank You

Thank you for helping make ci4commonModel better! Your contribution is appreciated 💙