Confirmed users
3,376
edits
Auto-tools/Projects: Difference between revisions
Jump to navigation
Jump to search
→Guidelines: - minor update, clarification
(Remove firefoxos section) |
(→Guidelines: - minor update, clarification) |
||
| Line 57: | Line 57: | ||
=== Guidelines === | === 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: | Guidelines for what to include in project documentation: | ||
| Line 65: | Line 66: | ||
* Documentation for how to use the project (or how it will be used) | * Documentation for how to use the project (or how it will be used) | ||
* How to setup / develop / test the project | * How to setup / develop / test the project | ||
* Milestones and features to be developed (bugzilla table) | * 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) | * Good first bugs and how to get started (bugzilla table, link to well annotated github issues, etc.) | ||
* How to submit a patch | * How to submit a patch | ||
* Coding style guidelines and expectations | * Coding style guidelines and expectations | ||