Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 2.7 KB
Raw

Contributing to Lion-Packages Open-Source PHP Projects

Thank you for considering contributing to our open-source projects! We strive to maintain a collaborative and welcoming environment for all contributors. Before submitting your contribution, please take a moment to review the following guidelines.

Contribution Guidelines

  1. Mutual Respect: Treat all community members with respect. We do not tolerate harassment or offensive behavior.

  2. Adherence to PSR Standards: Our PHP projects follow the standards defined by PHP-FIG. Please ensure that your code complies with the relevant PSR standards.

  3. Adherence to Lion-Packages Standards: Our PHP projects also follow our own standards along with the PSR, lease Lion-Packages Standards.

  4. Creating an Issue: Before starting work on a new feature or bug fix, please open an issue to discuss it. This helps ensure that your contribution aligns with the project's goals and avoids duplication of effort.

  5. Branching Strategy: When contributing code, create a new branch off the main branch. Use a descriptive name for your branch that summarizes the changes you are making.

  6. Pull Request Process: When submitting a pull request, provide a clear and concise description of the changes you've made. Ensure that your code passes all tests and linting checks. If your pull request addresses an open issue, reference the issue number in the description.

  7. Code Reviews: All pull requests require review before merging. Be open to feedback and be willing to make changes based on reviewer suggestions.

  8. Documentation: If your contribution introduces new features or changes existing functionality, update the project's documentation accordingly.

  9. Licensing: By contributing to our projects, you agree to license your code under the same license as the project (typically MIT License). Ensure that any new files include the appropriate license header.

Getting Started

To contribute to our projects, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your changes to your forked repository.
  6. Open a pull request from your branch to the main branch of the original repository.

Thank you for contributing to Lion-Packages open-source projects! Your contributions help make our projects better for everyone.

If you have any questions or need further assistance, feel free to reach out to us or refer to our Code of Conduct.