Wiki source code of License Review Tool Requirements, Candidates and Selection
Version 21.1 by Pamela Chestek on 2020/04/28 16:44
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The [[License Review>>url:http://lists.opensource.org/mailman/listinfo/license-review_lists.opensource.org]] mailing list [[is considering>>url:http://lists.opensource.org/pipermail/license-review_lists.opensource.org/2018-June/003384.html]] using a project management tool for public tracking of the license review process. This page is for collecting information related to this tool selection. Note that the **license-review** list and corresponding that license review process in general distinct from the **license-discuss** mailing list, which this document does not address. | ||
| 2 | |||
| 3 | The License Committee recommends hiring a person to aid in the identification and implementation of a better workflow for the review of licenses. We have decided that the current email-based system (Mailman) is inadequate as it is exceedingly difficult to follow discussions, which reduces participation. The tasks that this person will undertake are: | ||
| 4 | |||
| 5 | Stage 1: | ||
| 6 | |||
| 7 | * Identify an appropriate license-review vehicle(s) with the attributes below | ||
| 8 | |||
| 9 | ((( | ||
| 10 | Stage 2: | ||
| 11 | ))) | ||
| 12 | |||
| 13 | * Implement the vehicle on an OSI-approved host | ||
| 14 | * Document the expected process for reviewing a license and the roles of all participants in the process | ||
| 15 | * Document the solution and any maintenance tasks so they can be handed off to a new maintainer | ||
| 16 | |||
| 17 | ((( | ||
| 18 | Stage 3: | ||
| 19 | ))) | ||
| 20 | |||
| 21 | * Evaluate feasibility of creating a complete, searchable database of all license-review emails, either incorporated into the tool or separate from the tool (currently emails are at at least three different urls) | ||
| 22 | |||
| 23 | ((( | ||
| 24 | The person may also be asked to: | ||
| 25 | |||
| 26 | * Create a maintainable system for making machine-readable licenses available | ||
| 27 | * Create a complete, searchable database of all license-review emails | ||
| 28 | ))) | ||
| 29 | |||
| 30 | == Requirements for license-review process == | ||
| 31 | |||
| 32 | ==== Must have ==== | ||
| 33 | |||
| 34 | * Ability to submit a license for review | ||
| 35 | * Being able to immediately identify the current state of review for a license (eg. "approved", "rejected", "new", "being redrafted", "invalid", "rejected", etc.) | ||
| 36 | * Ability to submit updated revisions of a license, without destroying previous ones or associated history. (Licenses often go through multiple rounds of revisions or drafts based on feedback received.) | ||
| 37 | * Ability to comment on specific sections/words/lines of a given draft of license. (Sections of licenses that have been revised are areas of interest) | ||
| 38 | * Ability to comment on a license in a general sense | ||
| 39 | * Ability to moderate discussions (including removing comments, editing comments, banning users) | ||
| 40 | * Ability to close the process with the publication of an accompanying rationale document | ||
| 41 | * Discussions must be publicly accessible, without authentication | ||
| 42 | * Users must authenticate and maintain a consistent identity in order to comment/participate in the process | ||
| 43 | * Time-stamping of all comments and submissions | ||
| 44 | * Entirely separate discussions for each license | ||
| 45 | * Discussions must be archiveable and available to reference through linking | ||
| 46 | * Easy to learn and use by non-technical users | ||
| 47 | * Must not assume experience with specific technical tools (i.e. requirement to use Git, XML, or a specific programming language, etc.) | ||
| 48 | * Tools should be open source | ||
| 49 | |||
| 50 | ((( | ||
| 51 | |||
| 52 | ))) | ||
| 53 | |||
| 54 | ==== Nice to have ==== | ||
| 55 | |||
| 56 | * Ability to cross-reference a different comment in the same or different discussion | ||
| 57 | * Searchable discussions | ||
| 58 | * Canonical URIs for each license for review | ||
| 59 | * Machine-readable output from the license review process (text of the license + metadata such as Author, Date approved, Link to discussion, etc.) | ||
| 60 | * Low administrative overhead/hosted service (OSI does not have a good track record of hosting/maintaining new services) | ||
| 61 | * Previous license review emails can be added so that all license reviews are in the same place (we may need to engage someone separately to complete a migration) | ||
| 62 | * Configurable notifications in order to watch and follow discussions | ||
| 63 | * Welcoming to new community members | ||
| 64 | * Badges to easily identify participants to provide context (e.g. OSI board members, long-time community participants, etc.) | ||
| 65 | * Not mandatory to use the tool in order to participate in review, i.e., system integrates with an email workflow |