Skip to content

Latest commit

 

History

History
executable file
·
63 lines (50 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
63 lines (50 loc) · 2.78 KB

Contributing to yii2-grid

Looking to contribute something to yii2-grid? Here's how you can help.

Using the issue tracker

When reporting bugs or requesting features, the issue tracker on GitHub is the recommended channel to use.

The issue tracker is not a place for support requests. Refer the extension documentation and demos and/or refer to the webtips Q & A forum which are the better places to get help.

How to contribute via a pull request?

Refer this git workflow for contributors.

Reporting bugs with yii2-grid

We really appreciate clear bug reports that consistently show an issue within yii2-grid.

The ideal bug report follows these guidelines:

  1. Use the GitHub issue search — Check if the issue has already been reported.
  2. Check if the issue has been fixed — Try to reproduce the problem using the code in the master branch.
  3. Isolate the problem — Try to share a demo or a test case that consistently reproduces the problem.

Please try to be as detailed as possible in your bug report, especially if an isolated test case cannot be made. Some useful questions to include the answer to are:

  • What steps can be used to reproduce the issue?
  • What is the bug and what is the expected outcome?
  • What browser(s) and Operating System have you tested with?
  • Does the bug happen consistently across all tested browsers?
  • What version of jQuery are you using? And what version of yii2-grid?
  • Are you using yii2-grid with other plugins?

All of these questions will help others fix and identify any potential bugs.

Requesting features in yii2-grid

Before starting work on a major feature for yii2-grid, read the documentation first or you may risk spending a considerable amount of time on something which the project developers are not interested in bringing into the project.

Licensing

It should also be made clear that all code contributed to yii2-grid must be licensable under the BSD-3 license. Code that cannot be released under this license cannot be accepted into the project.