Repository Guidelines

Pull Request (PR) Acceptance Criteria

To ensure consistency and maintain the integrity of the repository, we have specific criteria for accepting Pull Requests (PRs):

1. File Header Requirement: Every file in the repository must include a standardized header. PRs will only be accepted if the modified or new files contain the correct header with the designated owner's name.

2. Code Testing: All submitted code, especially for complex filters, must be thoroughly tested to ensure it works as intended. Untested code will not be merged into the repository.

3. Pull Requests: Once a Pull Request is created, please notify the Devs that there is an outstanding PR to look at.

File Header Template

Use the following header template in all files to comply with the repository's standards. The 'Version History' and 'Contributors' fields are optional and can be included as needed:

/* 
 * Owner: [GitHub Username]
 *
 * Description:
 *    Brief description of what the script or file does. This should cover the main
 *    purpose and any important details about the functionality.
 *
 * Version History: (Optional)
 *    [Version Number] - [Date in YYYY-MM-DD format] - [Brief Summary of Changes]
 *    [Version Number] - [Date in YYYY-MM-DD format] - [Brief Summary of Changes]
 *
 * Contributors: [List of contributor usernames] (Optional)
 */