uKCP template

Disclaimer: This is a draft for a governance document for the useR! Knowledgebase project. It has not yet been discussed or approved and is not yet in effect. Update 2022-08-06: this template has been approved

uKCP template

Abstract

The abstract should be a short description of what the uKCP will achieve.

Detailed description

This section describes the need for the uKCP. It should describe the existing problem that it is trying to solve and why this uKCP makes the situation better. It should include examples of how the new functionality/content would be used and perhaps some use cases.

Implementation

This section lists the major steps required to implement the uKCP. Where possible, it should be noted where one step is dependent on another, and which steps may be optionally omitted. Where it makes sense, each step should include a link related pull requests as the implementation progresses.

Any pull requests or development branches containing work on this uKCP should be linked to from here. (A uKCP does not need to be implemented in a single pull request if it makes sense to implement it in discrete phases)

Backward compatibility

This section describes the ways in which the uKCP breaks backward Compatibility. In the context of uKCP, one could use this to discuss code backward compatibility, or significant divination in the useR! conference guidelines/experience.

Alternatives

If there were any alternative solutions to solving the same problem, they should be discussed here, along with a justification for the chosen approach.

Discussion

This section may just be a bullet list including links to any discussions regarding the uKCP:

This includes links to relevant GitHub issues.

References and Footnotes

[1] Each uKCP must either be explicitly labeled as placed in the public domain (see this uKCP as an example) or licensed under the Open Publication License.

Copyright

This document has been placed in the public domain. [1]

Edited Aug 06, 2022 by Andrea Sánchez-Tapia