Wiki source code of License Discuss & License Review reports
Version 2.1 by Patrick Masson on 2020/04/28 19:52
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The discussions occurring on both the License Discuss and License Review mailing lists are summarized in monthly reports and posted back to the corresponding mailing lists and the OSI website. | ||
| 2 | |||
| 3 | In order to ensure the reports and summaries of discussions are usable, concise, and consistent the following style guidelines have been adopted. | ||
| 4 | |||
| 5 | ~1. Report Title | ||
| 6 | |||
| 7 | * The monthly License-Discuss report is titled, "[MONTH] [YEAR] License-Discuss Report" | ||
| 8 | ** The URL for the License-Discuss report is formatted as, "https://opensource.org/LicenseDiscuss[YYYYMM]" | ||
| 9 | * The monthly License-Review report is titled, "[MONTH] [YEAR] License-Review Report" | ||
| 10 | ** The URL for the License-Review report is formatted as, "https://opensource.org/LicenseReview[YYYYMM]" | ||
| 11 | |||
| 12 | 2. Introduction (website only) | ||
| 13 | The OSI's content management system (Drupal), allows any "News" post (blog post) to include a summary of the contents on the OSI website's homepage. | ||
| 14 | * The homepage summary includes the content form the table of contents in paragraph form. | ||
| 15 | |||
| 16 | Example: | ||
| 17 | |||
| 18 | {{box}} | ||
| 19 | In [MONTH}, the License-[discuss/Review] mailing list discussed the [FIRST TOPIC SUBMITTED FOR THE MONTH], the [SECOND TOPIC SUBMITTED...], the [THIRD TOPIC...], and the [...]. | ||
| 20 | {{/box}} | ||
| 21 | |||
| 22 | 3. Table of Contents | ||
| 23 | |||
| 24 | * Each report will include a table of contents listing the topics discussed during the month. | ||
| 25 | * The order of the topics included in the table of contents is based on the date the topic was introduced to the mailing list: the oldest topics first, fol lowered by later topics added throughout the month. | ||
| 26 | * The table of contents will be included at the beginning of the report. | ||
| 27 | |||
| 28 | Example: | ||
| 29 | |||
| 30 | {{box}} | ||
| 31 | License-[Discuss/Review] mailing list topics for [MONTH] [YEAR]: | ||
| 32 | |||
| 33 | [FIRST TOPIC SUBMITTED FOR THE MONTH] | ||
| 34 | [SECOND TOPIC SUBMITTED...] | ||
| 35 | [THIRD TOPIC...] | ||
| 36 | [...] | ||
| 37 | {{/box}} | ||
| 38 | |||
| 39 | 2. Topic Headers | ||
| 40 | |||
| 41 | * Each topic will be listed as a new header level 3). | ||
| 42 | |||
| 43 | 3. Topic Introduction | ||
| 44 | |||
| 45 | * The introductory post introducing a new topic will be summarized to emphasize the specific issue (for L-D) or license (for L-R) introduced. | ||
| 46 | * The URL will be included after the summary of the introductory post. | ||
| 47 | |||
| 48 | 4. Topic Discussions (Posts) | ||
| 49 | |||
| 50 | * Only discussion posts including additional relevant (on topic) issues should be included summarized in the report. | ||
| 51 | * Responses to the initial issue(s) should not be included. Readers can click to the thread to follow the discussion. | ||
| 52 | |||
| 53 | ---- | ||
| 54 | |||
| 55 | Glossary of Terms | ||
| 56 | |||
| 57 | * Discussion - the thread of posts in response to a topic. | ||
| 58 | * Mailing List - a forum for email-based discussions managed by the OSI on the MailMan platform. | ||
| 59 | * Post - a message sent by a mailing list user to the mailing list forum. | ||
| 60 | * Report - the entire content of a month's License-Discuss and License-Review posted to the OSI website and corresponding mailing list. | ||
| 61 | * Summary - a brief transcript of a mailing list post send by a mailing list user. | ||
| 62 | * Topic - a single subject introduced to the License-Discuss or License-Review mailing list. | ||
| 63 | * Topic Header - the text included in a License-Discuss or License-Review report introducing a new topic. |