Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

42 lines (35 loc) · 2.53 KB
Raw

Contribution process

Thank you, your help is most appreciated, and improves experience for everyone! Please follow the guidelines to keep it simpler for both sides. Contact us if unsure or in case if you have to massively violate these guidelines

Notes on content

Please check our issue tracker for issues corresponding to the problem you're fixing with your pull requests. Create issue on issue tracker describing the problem if there doesn't exist. Please link pull request/commit messages to the issue.

Code Style

  • Please avoid any unnecessary changes e.g., spacing, line endings, HTML formatting. Remember, these files are NOT for human consumption. We want to preserve meaningful history.
  • Please try to match existing style for any particular file - formatting, spacing, naming conventions.
  • Please add corresponding @since tags
  • Please run docker-compose -f docker-compose.yml run test_runner composer cs to check the code style and docker-compose -f docker-compose.yml run test_runner composer cs-fix to fix it

Typehints In Signature

  • Please ensure that typehints in signature match types returned by reflection. If reflection doesn't return any type please add such typehints via PhpDoc
  • If typehint (or type generally) of entity should be different for different PHP versions please use LanguageLevelTypeAware attribute in next format:
    #[LanguageLevelTypeAware(['<PHP_VERSION>' => '[type]', '<PHP_VERSION>' => '[type]'], default: '[type]')].
    Short example
<?php
use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware;
class Error implements Throwable
{
    #[LanguageLevelTypeAware(['8.1' => 'string'], default: '')]
    protected $file; //since 8.1 propery has typehint `string` according to reflection but didn't have any typehints before
}
//or for the function
#[LanguageLevelTypeAware(['8.0' => 'CurlHandle|false'], default: 'resource|false')]
function curl_copy_handle(#[LanguageLevelTypeAware(['8.0' => 'CurlHandle'], default: 'resource')] $handle) {}

Tests

  • Please make sure that tests pass for your Pull Request.
  • If necessary, please include changes to mutedProblems.json.

Types of contribution

As of 2017.1 Preview we gladly accept all "non-standard" extensions and IDE get a UI for per-project configuration. As of 2016.3 there is an easy way to package your custom stubs/metadata as a plugin.