Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (67 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

94 lines (67 loc) · 3.33 KB
Raw

Contributing to WebFramework

First of all, thank you for taking the time to contribute! ❤️

All contributions, big or small, are welcomed and highly appreciated. Please review the Table of Contents below for guidance on how you can help make WebFramework even better.

If you love the project but don't have time to contribute, you can still support us by:

  • Starring the project on GitHub ⭐
  • Sharing it on social media 📢
  • Mentioning WebFramework in your projects or at meetups 🤝

Table of Contents

I Have a Question

Before asking a question, please:

If you still have questions:

  • Open a new issue.
  • Provide clear context and any relevant details (PHP version, platform, etc).

Reporting Bugs

Before Reporting a Bug:

  • Confirm you're using the latest version of WebFramework.
  • Check existing issues to see if your bug has already been reported.
  • Try to reproduce the issue consistently.

How to Submit a Bug Report:

  • Open a new issue.
  • Clearly describe the expected vs. actual behavior.
  • Provide detailed reproduction steps and relevant information (PHP version, OS, error logs).

Important: Security-related issues must not be reported publicly. Please contact maintainers directly via email.

Suggesting Enhancements

Before Submitting an Enhancement:

  • Make sure the enhancement fits the scope and goals of WebFramework.
  • Search existing issues to ensure it hasn't been previously suggested.

How to Submit an Enhancement:

  • Open a new issue.
  • Describe clearly what you propose and why it would benefit most users.
  • Provide examples or references from other projects if applicable.

Submitting Your First Contribution

  1. Fork and Clone:

    git clone https://github.com/YOUR_GITHUB_USERNAME/webframework.git

  2. Create a Branch:

    git checkout -b feature-name-or-fix

  3. Implement Changes:

    • Follow existing code styles and patterns.
    • Include clear documentation and tests if necessary.

  4. Commit and Push:

    git add .
git commit -m "Add clear description of your changes"
git push origin feature-name-or-fix

  5. Open a Pull Request:

    • Clearly describe your changes and why they are valuable.

Improving the Documentation

Improving documentation is a great way to contribute. You can help by fixing typos, clarifying content, or writing new documentation.

Commit Message Guidelines

  • Use clear, descriptive commit messages.
  • Briefly explain "what" and "why" you made the changes.

Thanks again for helping us make WebFramework even better! 🎉