Skip to content

Latest commit

 

History

History
100 lines (51 loc) · 3.61 KB

cap00001.md

File metadata and controls

100 lines (51 loc) · 3.61 KB

CAP: 1

Author: Froilán Irizarry <[email protected]>

Created: 2013-05-29

Licence: Attribution 3.0 Unported

Type: Documentation

Version: 0.0.1

Purpose

The following document was made as a proposal for the format of the Community Action Proposal, a document to be used to submit proposal to the Startups of Puerto Rico ( SoPR ) Community.

Summary

The following document proposes the format for the CAP document to be used by SoPR. The format suggested follows loosely the format used by the Python PEP, with some changes. The format is made to be simple and straight forward to encourage member participation but at the same time to facilitate management and readability.

Main

What is a Community Action Proposal ( CAP )?

A document describing a proposal for an action to be taken by the Starups of Puerto Rico Community. These actions could be anything from help in marketing a product to a community activity.

Why do we need a CAP?

It is a simple, fair, and open way for community members to participate in the governance of SoPR. It gives all community members and guests a way to voice opinion and propose direction of SoPR and it also serves as a historical account of member opinion and community action.

Who can submit a CAP?

Any one. This will not be limited to active community members. It is meant to foment participation and fair opportunity for all to voice opinions and concerns.

Who will evaluate a CAP?

The SoPR board members will evaluate and answer CAPs as they arise and time allows.

What should go into a CAP?

The following is the proposed use for a CAP:

    • Events a community member would like the community to participate or help organise or promote

    • Changes to the community guide lines or governance.

How does one submit a CAP?

A CAP can be submitted via email, uploaded in the SoPR Google group, or as a pull request to the SoPR Github repo.

What’s the format of a CAP

The CAP follows the Python PEP format very loosely. CAPs must be explicitly labeled in the public domain or be licensed under a public domain license such as the Creative Commons Licence or the Open Publication License. The file type should be an open format such as palin text (.txt), Open document format ( .odf ) or markdown ( .md ) - preferred - to allow free access to the document to all regardless of operating systems.

The document structure should follow the following guide lines:

    1. Document “*meta data*”

      • CAP id

      • Title

      • Author(s) <[email protected]>

      • Date Created

      • License

      • Type:

        • Proposed types:

          • Governance - the proposal will touch or propose changes or additions to the governance rules of SoPR

          • Event - the proposal will touch or propose the community participation in an event

          • Petition - the proposal will make a petition to the community

          • Documentation - proposed changes to documentation and guides

      • Version - this should follow the mayor.minor.bug/fix format. E.g. 1.0.0

    2. Purpose

      • A brief purpose of the CAP

    3. Summary

      • A brief summary (200 words maximum) of the document.

    4. Main

      • Body of document. As stated above the prefered format is markdown.

    5. Appendices

      • Only if really necesary.