|
|
| Line 11: |
Line 11: |
| === Overview === | | === Overview === |
| Work in progress effort to create an index for all existing/WIP automation tools - [[Auto-tools/Projects/Everything|Here]]. | | Work in progress effort to create an index for all existing/WIP automation tools - [[Auto-tools/Projects/Everything|Here]]. |
|
| |
| === Guidelines ===
| |
| The guidelines are evaluated based on the link we have to documentation (wiki, readme.md, readthedocs, etc.) This link should contain the information or in the first page of text have a link to additional information so that we can easily learn about the project.
| |
|
| |
| Guidelines for what to include in project documentation:
| |
| * The goals of the project
| |
| * Why the project is important to Mozilla and/or the A-Team
| |
| * Dependencies on other projects/teams, and its place in the greater ecosystem
| |
| * List out who to contact, mentors, active developers
| |
| * Documentation for how to use the project (or how it will be used)
| |
| * How to setup / develop / test the project
| |
| * Milestones and features to be developed (bugzilla table, link to well annotated github issues, etc.)
| |
| * Good first bugs and how to get started (bugzilla table, link to well annotated github issues, etc.)
| |
| * How to submit a patch
| |
| * Coding style guidelines and expectations
| |
|
| |
| When setting the priority of a project, consider this scale as a starting point:
| |
| * 1 - This is a stated goal for the current quarter | There are active people working on this | Other projects/teams depend on this completing
| |
| * 2 - There are active people working on this | We are committed to delivering at least one milestone in the current quarter
| |
| * 3 - This is an project that we and others believe would be beneficial to Mozilla, but we haven't promised to deliver it on a specific timeline. There are clear plans and maybe a prototype of one or more milestones to start with
| |
| * 4 - This is a good idea or a project that we worked on in the past which could use maintenance. We don't have resources for this now, but still feel it is a valuable project!
| |
|
| |
|
| === Firefox for Android === | | === Firefox for Android === |