Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 3.25 KB

Contributing

Contributing to this project is outlined in detail below. Briefly, all additions to this project must follow PSR-1 and PSR-12 Coding standards for PHP. This amounts to all variables and functions being camelCase, all class names being PascalCase, and all request parameters being snake_case.

For Javascript and Typescript, you can find standards in the .eslintrc.json file in the root of the project. Generally speaking though these styles amount to the ESLint coding standards. This amounts to all variables and functions being camelCase, and dictionary items being snake_case.

Other contributing details can be found below.

Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.

Procedure

Before filing an issue:

  • Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
  • Check to make sure your feature suggestion isn't already present within the project.
  • Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
  • Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

  • Check the codebase to ensure that your feature doesn't already exist.
  • Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

Requirements

  • PSR-12 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

  • ESLint Coding Standards - The easiest way to apply the conventions is to install ESLint.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.