Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.57 KB

Contributing

We'd love for you to contribute to our source code and to make php Bolt library even better than it is today! Here are the guidelines we'd like you to follow.

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our Code of Conduct.

Did you find a bug?

Ensure the bug was not already reported by searching on GitHub under Issues.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a piece of code?

Open a new GitHub pull request with the patch. Don't forget to run phpunit when you make changes.

Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Clean code

We like to keep the code unified and clean as possible.

  • Follow PHP Standards Recommendations (PSR)
  • Avoid import with use function <php_function>;
  • Use type specification for method arguments
  • Set methods return type
  • Add descriptive method annotations if needed
  • Don't use @deprecated annotation
  • Follow Bolt specification by official documentation


PHP Bolt library is a volunteer effort. We are thankful for your interest or contribution.