Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (35 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 1.82 KB
Raw

🤝 CONTRIBUTING

Thank you for your interest in contributing to cirebonweb/core!

This package is designed to support maintainers, interns, and developers working with CodeIgniter 4. It includes modular publishing commands, region-aware logic, and customizable admin panels using AdminLTE and Shield authentication.

🧭 Philosophy

We prioritize:

  • Maintainability and clarity over cleverness
  • Documentation that educates, not just explains
  • Helpers and modules that are auditable, override-friendly, and scalable
  • Local developer empowerment through Bahasa Indonesia PHPDoc comments

🛠️ How to Contribute

You can contribute in many ways:

  • Improve or translate documentation (especially PHPDoc blocks)
  • Refactor or extend helpers and publishing logic
  • Report bugs or suggest enhancements via GitHub Issues
  • Submit pull requests for new features or fixes

📚 Guidelines

  • Use PSR-12 coding standards
  • Keep helpers modular and testable
  • Prefer plain text documentation blocks for maintainers and interns
  • Avoid magic logic—make everything traceable and override-friendly
  • If adding new publishable resources, update COMMAND.md and README.md

🌍 Language Note

Documentation inside the code (PHPDoc /** ... */) is written in Bahasa Indonesia to support local maintainers and interns. Feel free to contribute in English or Indonesian—both are welcome.

🧪 Testing

If you add new helpers or modules, please include basic PHPUnit tests or usage examples. We aim to make testing part of the educational starter kit.

📝 License

This project is licensed under the MIT License. By contributing, you agree that your code will be released under this license.

We appreciate every contribution—big or small. Terima kasih!