1.3 KiB
Submission Checklist
This document serves as a handy checklist for submitted merges and patches to the GNU social project. Following it isn't a gaurantee a patch will be accepted, but it will help you avoid common problems.
-
Ensure all code control paths in all functions return a value.
-
Ensure all exceptions are trapped in an exception class, or minimally, written to the log with common_log
-
Ensure the coding format standards are adhered to (see coding_standards.md)
-
Ensure that any new class that deals in public data has a corresponding new API endpoint.
-
Ensure that all new API endpoints sanitize inputs and outputs properly.
-
Ensure that your version of the code works with PHP 7 on a standard LAMP and LEMP stack (Linux+Apache+MariaDB+PHP and Linux+nginx+MariaDB+PHP)
-
If implementing new database functions, ensure they work with MariaDB and postgreSQL.
-
Ensure all data that federates does so properly and has mechanisms to catch and accomodate for federation transmission failure.
-
Ensure that nothing is left in an error state when it is avoidable.
-
Ensure that all code submitted is properly documented.
-
Ensure that there are no PHP Strict Standards or Parse errors in the code.