Skip to content

Commit d786b72

Browse files
committed
CONTRIBUTING: Make a nice big warning against altering user input
1 parent b440e3c commit d786b72

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ When expanding Kint, keep in mind its main priorities:
1313
5. **Code quality**: the nature of Kint implies that it will be continued to develop for many years - at least to adapt to new language features and quirks. Keep the codebase as maintainable as possible. Keep code style consistant by finishing every commit with `composer format`.
1414
6. **Stable releases**: Try not to push backwards compatability breaking or untested changes to the master branch. Because it is a development tool, people may leave their `composer require-dev` Kint configuration to allow auto-updates.
1515

16+
### Don't alter user input
17+
18+
For the parser to do proper recursion checking it has to take things by reference. Since it's taking things by reference there's a good chance your parser plugin can change your end-users data. **NEVER ALTER INPUT VARIABLES**
19+
1620
### Development instructions
1721

1822
```sh

0 commit comments

Comments
 (0)