socialde.pt / atp-schema
Parse and validate AT Protocol Lexicons with DTO generation for Laravel
fork atom
atp-schema / CONTRIBUTING.md
at main 3.4 kB view raw view code

Contributing#

Contributions are welcome and will be fully credited.

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#

  • Search existing issues to avoid duplicates
  • Check the documentation to ensure it's not a usage question
  • Provide a clear title and description
  • Include steps to reproduce the issue
  • Specify your environment (PHP version, Laravel version, Schema version)
  • Include relevant code samples and full error messages

Before Submitting a Pull Request#

  • Discuss non-trivial changes first by opening an issue
  • Fork the repository and create a feature branch from main
  • Follow all requirements listed below
  • Write tests for your changes
  • Update documentation if behavior changes
  • Run code style checks with vendor/bin/php-cs-fixer fix
  • Ensure all tests pass with vendor/bin/phpunit
  • Write clear commit messages that explain what and why

Requirements#

  • PSR-12 Coding Standard - Run vendor/bin/php-cs-fixer fix to automatically fix code style issues.

  • Add tests - Your patch won't be accepted if it doesn't have tests. All tests must use PHPUnit with Pest.

  • 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 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.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Running Tests#

vendor/bin/phpunit

Run specific test suites:

# Unit tests only
vendor/bin/phpunit --testsuite=unit

# Integration tests only
vendor/bin/phpunit --testsuite=integration

Code Style#

Schema follows PSR-12 coding standard. Run PHP CS Fixer before submitting:

vendor/bin/php-cs-fixer fix

Happy coding!