Skip to content

Contributing to Atoolo#

Thank you for your interest in contributing to Atoolo! Your contributions help us to improve and develop this project. Here are some guidelines and information to help you make your contribution.

Code of Conduct#

Please read the following Code of Conduct before you start contributing. We expect all contributors to adhere to these guidelines in order to create a respectful and welcoming environment.

Bug Reports#

If you have found a bug, please follow these steps:

  1. Search for similar issues: Check if the issue has already been reported by searching in the.
  2. Create a new issue: If the issue has not yet been reported, create a new issue and provide as many details as possible:
  3. A clear and concise description of the problem.
  4. Steps to reproduce the bug.
  5. Expected behavior vs. actual behavior.
  6. Environment (PHP version, operating system, etc.).

Feature Requests#

We are always open to new ideas and improvements! If you would like to suggest a new feature:

  1. Discuss your idea: Open an issue and describe the proposed feature. We look forward to your feedback and ideas. 2 Be detailed: Describe why the feature is useful and how it could be implemented.

Pull Requests#

We look forward to your pull requests! To make sure everything goes smoothly, please follow these steps:

  1. Fork the repository: Make a copy of this repository in your own GitHub account.
  2. Create a new branch: Work on a separate branch of main, e.g. feature/your-function or bugfix/your-bugfix.
  3. Make sure that all coding rules are followed: Use the appropriate tools in the projects.
  4. Write meaningful commits: Provide clear and concise commit messages that describe the changes made. Adhere to the Conventional Commits Specification.
  5. Create the pull request: Open a pull request and describe your changes. Link any relevant issues.

Coding Style#

This project uses the PER Coding Style 2.0. Please make sure that your code complies with these guidelines. Further information can be found in the PER Coding Style 2.0 documentation.

Conventional commits#

This project uses the Conventional Commits Specification. Please adhere to this specification when creating commits.

Tests#

Make sure that all tests are successful and add new tests for your changes if possible. Execute the tests before creating a pull request.

Code Coverage#

Make sure that your changes do not reduce the code coverage. The goal is 100% code coverage. Where 100% means that the code is tested that should be tested. It is legitimate to work with @codeCoverageIgnore if the code cannot be tested.

The aim of the tests should also be to determine whether the entire project is also executable for future PHP versions.

Documentation#

If your changes affect the documentation, make sure that the documentation is updated. To do this, create a new pull request in the project Atoolo Docs

Contact#

If you have any questions or need help, please do not hesitate create an issue.

Thank you for your contribution!

Atoolo Team