Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 2.9 KB
Raw

Prerequisites

Getting started

Since Yii 3 consists of many packages, we have a special development tool.

  1. Clone the repository.

  2. Set up your own fork.

  3. Now you are ready. Fork any package listed in packages.php and do ./yii-dev install username/package.

  4. Create a new branch for your changes.

If you are only going to make a pull request in a single repository, simply create the new branch, where the name correctly identifies the fix or feature to be made.

if you are going to make a pull request in multiple repositories, create a new branch with the same name in all repositories, this allows our github actions workflow to sync all branches, and tests to run correctly.

  1. Check your changes.

Reporting issues

Please follow the guidelines below when creating an issue so that your issue can be more promptly resolved:

  • Provide information including: the version of PHP, dbms and the type of operating system.
  • Provide the complete error call stack if available. A screenshot to explain the issue is very welcome.
  • Describe the steps for reproducing the issue. It would be even better if you could provide code to reproduce the issue.
  • If possible you may even create a failing unit test and send it as a pull request.

If the issue is related to one of the dbms packages, please report it to the corresponding repository.

If you are unsure, report it to the main repository (https://github.com/yiisoft/db-mssql/issues).

Do not report an issue if

  • you are asking how to use some Yii DB MSSQL feature. You should use the forum or telegram for this purpose.
  • your issue is about security. Please contact us directly to report security issues.

Avoid duplicated issues

Before you report an issue, please search through existing issues to see if your issue is already reported or fixed to make sure you are not reporting a duplicated issue.

If you don't have any particular package in mind to start with:

  • Check roadmap.
  • Check package issues at github. Usually there are some.
  • Ask @samdark.