contributing

Your First Contribution

1. Fork the repo

2. Create a branch from master or main

3. If you've changed or add or remove codes, update the php documentation.

4. Make sure your code lints.

6. Issue that pull request!

If you have a different process for small or "obvious" fixes, let them know.

Small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted by a contributor as a patch, without a CLA.

As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following:

  • Spelling / grammar fixes

  • Typo correction, white space and formatting changes

  • Comment clean up

  • Bug fixes that change default return values or error codes stored in constants

  • Adding logging messages or debugging output

  • Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc.

  • Moving source files from one directory or package to another

Code review process

Last updated