Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

101 lines (62 loc) · 3.33 KB

Contributing to Lithe

Thank you for your interest in contributing to Lithe! We're excited to work with the community to improve Lithe even further. Please follow the guidelines below to ensure your contributions are effective and valuable to the project.

How to Contribute

Reporting Issues

If you encounter a bug or want to suggest a new feature, please open an issue in the Issues section of GitHub. When reporting an issue, include as much detail as possible:

  • A descriptive title.
  • Steps to reproduce the issue (if applicable).
  • Expected behavior vs actual behavior.
  • Screenshots or code examples (if applicable).
  • Version of Lithe and PHP being used.

Fork the Repository

Start by forking the repository to your GitHub account, and then clone it to your local machine:

git clone https://github.com/lithephp/framework.git

Create a Branch

Create a new branch to work on your feature or bug fix. Name your branch descriptively based on the change you're making:

git checkout -b feature/my-new-feature

Make Changes

Make the necessary changes to the code. We encourage you to:

  • Follow Lithe's coding standards and best practices.
  • Ensure the code is clean, efficient, and well-documented.
  • Include comments and documentation where necessary.

Test Your Changes

Before submitting a pull request, make sure of the following:

  • Run the relevant tests (if applicable).
  • Ensure your code hasn’t broken any existing functionality.
  • Add tests for any new functionality, if applicable.

Commit Your Changes

After making changes, commit them with a clear and concise commit message. Follow the standard commit message format:

git commit -m "Descriptive message about the change"

Push Your Changes

Push your branch to your forked repository:

git push origin feature/my-new-feature

Submit a Pull Request

After pushing your changes, go to the original repository and submit a pull request:

  • Include a detailed description of your changes.
  • Reference any related issues (e.g., Fixes #123).
  • Add any relevant documentation or examples if necessary.

Code of Conduct

We expect all contributors to follow the Contributor Covenant Code of Conduct. This ensures a welcoming and respectful environment for everyone.

Style Guide

To maintain consistency in the project, please adhere to the following guidelines:

  • PHP Coding Standards: Follow the PSR-12 standards for PHP code.
  • Naming Conventions: Use camelCase for methods and variables, and PascalCase for class names.
  • File Structure: Ensure new files are placed in the appropriate directories. Respect the project’s file organization.

Tests

  • PHPUnit is used for testing. Be sure to write tests for any new features or bug fixes.
  • Ensure all tests pass before submitting a pull request.

Documentation

  • Ensure your code is well-documented, especially for new features or changes to existing features.
  • If your contribution adds or modifies functionality, update the relevant sections of the documentation.

License

By contributing to this repository, you agree that your contributions will be licensed under the project's license (MIT).

Thank you for contributing to Lithe!