Recommend this page to a friend! |
Classes of Eric Sizemore | mimey PHP MIME Type Conversion | CONTRIBUTING.md | Download |
|
DownloadContributing to MimeyImportant NoteThe contributing guidelines for this project are heavily inspired by, and borrowed from, the contributing guidelines of PHPUnit. Welcome!This project accepts contributions of code and documentation from the community. These contributions can be made in the form of Issues or Pull Requests on the Mimey repository. Here are some examples how you can contribute: I look forward to your contributions! Code of ConductPlease note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Any contributions you make will be under the MIT LicenseWhen you submit code changes, your submissions are understood to be under the same MIT License that covers the project. By contributing to this project, you agree that your contributions will be licensed under its MIT License. Workflow for Pull Requests
Please make sure you have set up your username and email address for use with Git. You are encouraged to sign your Git commits with your GPG key. Backwards compatibility breaks in this project are being kept to an absolute minimum. Please take this into account when proposing changes. GuidelinesBefore we look into how, here are the guidelines. If your Pull Requests fail to pass these guidelines it will be declined, and you will need to re-submit when you?ve made the changes. This might sound a bit tough, but it is required for me to maintain quality of the code-base. Git CheckoutThe following commands can be used to perform the initial checkout of Mimey:
Install Mimey's dependencies using Composer:
PHP Style and Coding GuidelinesPlease ensure all new contributions match the PSR-12 coding style guide. This project attempts to adhere to PHPStan level 9 with strict rules and bleeding edge. Please ensure any contributions do as well. This project comes with configuration files for various tools that are used within the development workflow of this project. Please understand that I will not accept a pull request when its changes violate this project's coding guidelines. Coverage CheckNo configuration is needed for PHPUnit Coverage Check. You can use PHPUnit Coverage Check to check the coverage percentage in the codebase after your changes. I try to stick to 100% line coverage.
PHPStanThe configuration file can be found at
PHP-CS-FixerThe configuration file can be found at
PsalmThe configuration file can be found at
Unit tests (via PHPUnit)The configuration file can be found at
DocumentationIf you change anything that requires a change to documentation then you will need to add it. New methods, parameters, changing default values, adding constants, etc. are all things that will require a change to documentation. The change-log must also be updated for every change. Also, PHPDoc blocks must be maintained. Documenting functions/variables (PHPDoc)Please ensure all new contributions adhere to: when documenting new functions, or changing existing documentation. Changelog EntriesIf adding new changelog entries, please ensure they adhere to the Keep a Changelog format as much as possible. |