File: CONTRIBUTING.md

Recommend this page to a friend!
  Classes of Fernando Val  >  PHP Brazilian Numbers Validation  >  CONTRIBUTING.md  >  Download  
File: CONTRIBUTING.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PHP Brazilian Numbers Validation
Validate documents like CPF, CNPJ, CNH and NIS
Author: By
Last change:
Date: 7 months ago
Size: 1,474 bytes
 

Contents

Class file image Download

Contributing

I'm really glad you're reading this because we need volunteers to help with this project.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Code of Conduct

Please note we have a code of conduct, please follow it in all your interactions with the project.

Coding conventions

This project follows PHP-FIG PSR-12: Extended Coding Style specification and has integration with StyleCI to validate it.

We also use PHP Mess Detector to avoid "ugly" codes.

The main repository is integrated with Codacy to measure code quality,

Testing

We try to have most as possible code coverage tests and uses PHPStan and PHPUnit to it.

Submitting changes

Before sending a pull request to this repository, ensure you have followed these steps:

  • Write test cases if you are developing new features, and update README.md file with usage samples.
  • Ensure your changes don't break any test case.
  • Make sure all of your commits are atomic (one feature per commit).

Once you have done the above steps, send a pull request with a clear description and a list of what you've done.


For more information send a message to info at phpclasses dot org.