-
How to Contribute
General Welcome folks to the community and be awesome! Answer questions. Report issues like a pro (see below). Triage issues already reported! Test pre-releases. Contribute docs. Help translate Vanilla. Evaluate community addons & offer feedback. Do accessibility testing! Unplug your mouse, turn on a screen reader, and see…
-
Code of Conduct
Adapted from Swift’s Code of Conduct v1.3 for now because a copied code is better than no code. As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating…
-
Using Pull Requests to Contribute
We love pull requests! They’re the core of our workflow. All code is added to Vanilla via pull requests (PRs). A pull request is simply a request to merge code from a particular branch into another (usually a feature/significative-name or fix/significative-name or refactor/significative-name branch into master). GitHub’s…
-
Coding Standard - PHP
As of May 2014, Vanilla will adhere to PSR-2 (and therefore PSR-1) with a few exceptions. We have been mass-updating our source code as possible without breaking backwards compatibility (most notably by refraining from changing the casing of existing variables). We’ve named our primary exception to PSR-2 the Lord…
-
Coding Standard - Typescript
As of April 2018, Vanilla will follow the following coding standard for all frontend scripts. Existing code should not (and cannot) be mass-updated, but all new code must follow this standard. We adopted this standard for all the usual reasons: our team is growing, and we want to make sure things stay consistent between…
-
Naming Standards - Database
The original database naming standard in Vanilla was CapitalCase. This was inline with coding standards implemented at the beginning of the project. However, Vanilla has moved on. Following the events of The Casening, where most of the project was updated to camelCase, new database tables will share the same style used by…
-
Avoiding XSS
Overview While Vanilla has a bug bounty program, which has been incredibly helpful in finding and patching numerous security issues, it is important to write code that is secure from the start. This is a working document that represents best practices for writing secure code in Vanilla. XSS (General) One of the most common…