Skip to content

Commit

Permalink
markdown linting and related fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ebullient committed Feb 2, 2024
1 parent cdee4ff commit fc45df2
Show file tree
Hide file tree
Showing 26 changed files with 577 additions and 120 deletions.
5 changes: 3 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ insert_final_newline = false
indent_style = space

[*.md]
indent_size = 2
indent_size = 4
trim_trailing_whitespace = false
insert_final_newline = true

[*.{yaml,yml,html,js,rb,css,xml,scss}]
indent_size = 2
indent_size = 2
3 changes: 3 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
MD007:
indent: 4
MD013: false
4 changes: 0 additions & 4 deletions BOOTSTRAPPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ status: draft

This document outlines the preliminary, non-binding agreement for the establishment phase of the Commonhaus Foundation (CF), aiming to foster a collaborative community dedicated to open-source projects.

[cfc]: ./bylaws/3-cf-council.md
[cc-dm]: ./bylaws/5-decision-making.md

## Preliminary Commitment
Expand All @@ -26,12 +25,10 @@ Post-organization, there is a Formation Period for projects to contribute to CF'

Decisions should follow (and refine) the [CF decision making process][cc-dm].


## Binding Commitments Post-Formation

Projects commit to binding agreements such as trademark donations after the Formation Period, contingent upon continued quorum support.


If fewer than the quorum decide to commit their trademarks after the Formation Period, the remaining projects have the right to withdraw their membership without any penalties or obligations.

- [?] Transition to Binding Commitments: Define the criteria and process for transitioning from non-binding to binding commitments.
Expand All @@ -45,4 +42,3 @@ Regular feedback sessions will address concerns, suggest changes, and ensure ali
## Acknowledgement

By signing this agreement, the undersigned representatives of the participating projects acknowledge their understanding of these terms and express their non-binding intent to support the establishment of the Commonhaus Foundation.

8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ follows the [Commonhaus Foundation (CF) CoC][coc-policy].

- **Project-related Issues:** Each CF project will define a `CODE_OF_CONDUCT.md`. For issues related to a project, start there.
- **Foundation-wide Issues:** Issues related to the CF should be sent to the [`report` mailing list][CONTACTS.yaml] for [review][coc-response] by the [Commonhaus Foundation Council][cfc] (CFC).
- The CFC will follow [CF CoC procedures][coc-reports] when handling CoC reports.
- Records will be kept in TODO-private-repository. Access to this repository is restricted to current CFC members.
- The CFC will follow [CF CoC procedures][coc-reports] when handling CoC reports.
- Records will be kept in TODO-private-repository. Access to this repository is restricted to current CFC members.
- **Escalations:** [Escalations][coc-escalate] should be sent to the [`coc-escalation` mailing list][CONTACTS.yaml] for review by the [Code of Conduct Panel (COCP)][cocp].
- The [CoCP][cocp] will follow [CF CoC procedures][coc-reports] when handling CoC reports and escalations.
- Records will be kept in TODO-private-repository. Access to this repository is restricted to CoCP members.
- The [CoCP][cocp] will follow [CF CoC procedures][coc-reports] when handling CoC reports and escalations.
- Records will be kept in TODO-private-repository. Access to this repository is restricted to CoCP members.

To avoid duplication, please see the [CF CoC][coc-policy] for more information

Expand Down
2 changes: 1 addition & 1 deletion COMMUNICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

TBD -- finalize all communication channels

- Mailing lists are in `CONTACTS.yaml`
- Mailing lists are in `CONTACTS.yaml`
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Thanks for considering a contribution to the Commonhaus Foundation (CF) reposito

## Quick Start

- **Discuss First**: For significant changes, start a GitHub discussion to gather consensus[^1]. For smaller edits, you can directly create a pull request (PR).
- **Discuss First**: For significant changes, start a GitHub discussion to establish consensus[^1]. For smaller edits, you can directly create a pull request (PR).

- **Fork and Edit**: Fork the repository to your account, make your changes there.

Expand All @@ -17,8 +17,11 @@ Thanks for considering a contribution to the Commonhaus Foundation (CF) reposito
- **Remain Consistent**: Follow the existing format and structure of the documents.
- **Cross-reference Discussions and PRs**: Link back to relevant discussions or other PRs in your commit messages.
- **Building documents (optional)**: When you create a PR, a build will run that will verify internal and external links, and will generate and attach pdfs to the build.
- **Verify links**: To validate links locally, use `npm ci` to install node dependencies; `npm run test` or `npm run tv` to validate links.
- **Build pdfs**: If you use docker or podman, run `./.github/docker-build-pdf.sh` to use a pre-configured docker image to convert markdown bylaws and policies to pdf.
- **Test your changes**: To test your changes locally, , use `npm ci` to install node dependencies, and use `npm run test` or `npm run tv` (verbose) to test/lint your content. These tasks run the following:
- **Markdown linting**: `npm run lint`
- **YAML syntax validation**: `npm run yaml`
- **Markdown link checks**: `npm run links` or `npm run linksv` (verbose)
- **Build pdfs**: If you use docker or podman, run `./.github/docker-build-pdf.sh` to use a pre-configured docker image to convert markdown bylaws and policies to pdf.

## Submitting Changes

Expand All @@ -28,12 +31,12 @@ Thanks for considering a contribution to the Commonhaus Foundation (CF) reposito

## Legal Review

Some changes may need a legal review. Your patience is appreciated during this process.
Some changes may need a legal review which may take some time.

## Thank You

Every contribution matters. For any questions, feel free to reach out.

Happy contributing!

[^1]: See [decision making](./bylaws/5-decision-making.md#general-decision-making) for an overview of how we approach consensus building.
[^1]: See [decision making](./bylaws/5-decision-making.md#general-decision-making) for an overview of how we approach consensus building.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
status: draft
---
# The Commonhaus Foundation (CF)

> 📝 Note: This repo is a draft to explore an idea.
> It tries to be reasonably thorough to convey the concept, but there are lots of holes and details to sort through, and none of it has undergone any kind of legal review.
> [Discussions](https://github.com/commonhaus/foundation-draft/discussions) are open and input is welcome!
> If you're willing to support this effort, please submit a PR to add yourself to [SUPPORTERS.yaml](https://github.com/commonhaus/foundation-draft/blob/main/SUPPORTERS.yaml).
# The Commonhaus Foundation (CF)

The Commonhaus Foundation champions open-source innovation and collaboration.

We are dedicated to ensuring the long-term growth and stability of GitHub-style open-source projects through community collaboration and shared stewardship. Our mission is to empower a diverse community of contributors to create, maintain, enhance, and secure vital open-source libraries and frameworks.
Expand Down Expand Up @@ -65,7 +64,6 @@ CF is committed to inclusive growth, opening its doors to all individuals who sh
- [Security Policy][sec-policy]
- [IP Policy][ip-policy]


[codehaus]: https://www.infoworld.com/article/2892227/codehaus-the-once-great-house-of-code-has-fallen.html
[Bylaws]: bylaws/0-preface.md
[cfab]: bylaws/4-cf-advisory-board.md
Expand Down
6 changes: 3 additions & 3 deletions bylaws/0-preface.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Welcome to the Commonhaus Foundation (CF), a collective dedicated to nurturing o
- **[CF Advisory Board][cfab]**: Comprises representatives from organizations providing financial support to the CF. They provide strategic insight to the CFC.
- **[General Members][membership]**: Individuals supporting CF’s mission. Members in good standing participate in CF activities and vote in elections.
- **[Projects][project]**: Collaborative open-source initiatives under CF, including assets like code, trademarks, and domains.
- **[Code Owners][plco]**: Maintain the quality and consistency of project code.
- **[Project Leaders][plco]**: Guide project governance and decision-making. Along with the CFC, they form the [**Extended Governance Committee (EGC)**][egc] for critical decisions like bylaw amendments.
- **[Code Owners][plco]**: Maintain the quality and consistency of project code.
- **[Project Leaders][plco]**: Guide project governance and decision-making. Along with the CFC, they form the [**Extended Governance Committee (EGC)**][egc] for critical decisions like bylaw amendments.

## Decision Making and Voting

Expand All @@ -30,7 +30,7 @@ In addition to our bylaws, the Commonhaus Foundation (CF) adopts specific polici
- [**Code of Conduct**][policy-coc]: Definition of behavioral expectations and conflict resolution and remediation in support of a respectful and inclusive community.
- [**Conflict of Interest**][policy-coi]: Establishes protocols for identifying, disclosing, and managing any personal or financial interests that could potentially interfere with the impartial and objective operation of the CF.
- [**Intellectual Property Policy**][policy-ip]: Framework for responsibly managing and protecting intellectual contributions.
- [**Security Policy**][policy-sec]:
- [**Security Policy**][policy-sec]:
- [**Succession Plan**][policy-sp]: Strategy to ensure leadership continuity and project resilience.
- [**Trademark Policy**][policy-tp]: Guidelines for the appropriate use of CF’s intellectual property.

Expand Down
2 changes: 1 addition & 1 deletion bylaws/1-purpose.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ For the purposes of governance and legal compliance, the Commonhaus Foundation C

The CF may have offices either within or outside the Central Florida area (or anywhere throughout the State of Florida), as the [CF Council][cfc] (CFC) may designate or as the affairs of the CF may require from time to time.

[cfc]: ./3-cf-council.md
[cfc]: ./3-cf-council.md
12 changes: 5 additions & 7 deletions bylaws/2-cf-membership.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The following section outlines the different types of membership and the process
- [Inactive or Retired Members](#inactive-or-retired-members)
- [Suspension and Revocation of Membership](#suspension-and-revocation-of-membership)


## Projects

A **project** within the CF represents collaborative innovation in open-source technology. These projects are dynamic collectives of individual contributors, functioning as self-organizing units rather than formal legal entities.[^1]
Expand All @@ -38,10 +37,10 @@ A **project** within the CF represents collaborative innovation in open-source t

## General Members

**Join as an individual.** Membership to the CF is open to all individuals who share our mission and are willing to contribute[^3].
**Join as an individual.** Membership to the CF is open to all individuals who share our mission and are willing to contribute[^3].

- **Path to Membership:** Engage with the CF or one of its projects in any capacity for three months to gain eligibility. Whether it's contributing code, documentation, community management, or advocacy, your active participation is the key to becoming a member.
- **Application Process:** To formalize your membership, submit an application (*details TBD*). The CFC will review each application, focusing on your contributions and alignment with our values.
- **Application Process:** To formalize your membership, submit an application (*details TBD*). The CFC will review each application, focusing on your contributions and alignment with our values.

Our review process is transparent. Declined applicants receive explanations and can appeal. Our aim is always to be fair and act in the best interest of the CF community.

Expand All @@ -63,7 +62,7 @@ While the CF thrives on the passion and contributions of its members, nominal me

## Inactive or Retired Members

Life happens, and we understand that. Members may choose to step back or retire, and we respect that decision.
Life happens, and we understand that. Members may choose to step back or retire, and we respect that decision.

- **Voluntary Resignation:** Members can choose to retire at any time, transitioning to an emeritus or inactive role while remaining part of our community.
- **Inactivity:** Members who are inactive for more than 12 months will transition to an inactive status. They can reactivate their membership by contacting the CFC.
Expand All @@ -74,16 +73,15 @@ Inactive members (of any type) do not have the right to vote in CFC elections an

The CFC may suspend or revoke the membership of any member that is found to be in violation of CF policies or acting against the best interests of the CF community.

- **Suspension:** The CFC may suspend a member for up to 90 days, during which the member may not participate in CF activities or vote in CFC elections.
- **Suspension:** The CFC may suspend a member for up to 90 days, during which the member may not participate in CF activities or vote in CFC elections.
- **Revocation:** The CFC may act to revoke or suspend CF membership if it believes (in good faith) that the member is engaging in willful misconduct or harming the best interest of the CF and its members.

These situations will be recorded as violations of the [Code of Conduct][coc] and handled as per the [Code of Conduct Resolution process][coc-reports].

The decision to revoke or suspend membership is made by a supermajority vote of the CFC. The member in question will be notified of the decision and the reasons for it.

[advisory board]: ./4-cf-advisory-board.md
[decision-making]: ./5-decision-making.md
[cfc]: ./3-cf-council.md
[egc]: ./3-cf-council.md#extended-governance-committee-egc
[coc]: ../policies/code-of-conduct.md
[coc-reports]: ../policies/code-of-conduct.md#handling-reports-and-escalations
[succession]: ../policies/succession-plan.md
20 changes: 10 additions & 10 deletions bylaws/3-cf-council.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ weight: 3
---
# Commonhaus Foundation Council and Offices

The Commonhaus Foundation Council (CFC) serves as the Board of Directors for the Commonhaus Foundation (CF). Governed by the legal requirements of the State of Florida and as defined in our Articles of Incorporation and [Bylaws][bylaws], the CFC is responsible for the strategic, governance, and fiduciary aspects of the Foundation.
The Commonhaus Foundation Council (CFC) serves as the Board of Directors for the Commonhaus Foundation (CF). Governed by the legal requirements of the State of Florida and as defined in our Articles of Incorporation and [Bylaws][bylaws], the CFC is responsible for the strategic, governance, and fiduciary aspects of the Foundation.

- **Member Communication**: Concerns or proposals can be addressed to the CFC at the [`council` mailing list][CONTACTS.yaml] *(TBD: or initiating a GitHub discussion, etc.)*.

- [Composition and Membership](#composition-and-membership)
- [Tenure, Transition and Apportioning Duties](#tenure-transition-and-apportioning-duties)
- [Officer Roles and Appointment](#officer-roles-and-appointment)
- [Tenure, Transition and Apportioning Duties](#tenure-transition-and-apportioning-duties)
- [Officer Roles and Appointment](#officer-roles-and-appointment)
- [Extended Governance Committee (EGC)](#extended-governance-committee-egc)
- [Meetings, Procedures and Decision-Making](#meetings-procedures-and-decision-making)
- [Agendas, Access, and Records](#agendas-access-and-records)
- [Electronic Participation and Decision-Making](#electronic-participation-and-decision-making)
- [Quorum](#quorum)
- [Voting](#voting)
- [Agendas, Access, and Records](#agendas-access-and-records)
- [Electronic Participation and Decision-Making](#electronic-participation-and-decision-making)
- [Quorum](#quorum)
- [Voting](#voting)
- [Committees and Delegation](#committees-and-delegation)

## Composition and Membership
Expand All @@ -40,7 +40,7 @@ An up-to-date list of CFC members will be maintained in the `cf-council` [CONTAC
- **Resignation:** CFC members wishing to resign must formally notify the Chairperson or the CFC, with immediate cessation of their responsibilities and rights as CFC members upon resignation.
- **Removal:** A CFC member may be removed for misconduct, failure to perform duties, or consistent non-participation. The removal process includes a fair review, an opportunity for the member to respond, and a decision made through a vote by the remaining CFC members or a general membership vote.
- **Vacancies:** In the event of a vacancy, duties are temporarily assigned to remaining members until a special election can be held to fill the vacated seat.
- **Apportioning Duties:** The CFC must ensure that all required [CFC Offices](#officer-roles-and-appointment) are filled.
- **Apportioning Duties:** The CFC must ensure that all required [CFC Offices](#officer-roles-and-appointment) are filled.

### Officer Roles and Appointment

Expand Down Expand Up @@ -89,7 +89,7 @@ The CFC uses electronic and (where possible) asynchronous methods for meetings a

### Electronic Participation and Decision-Making

Efficient participation and decision-making are essential for geographically dispersed CFC members.
Efficient participation and decision-making are essential for geographically dispersed CFC members.

- **Remote Involvement:** Meetings are conducted through teleconferencing and video conferencing tools.
- **Decision Making Outside Meetings:** Decisions are made outside of formal meetings through written consent, adhering to the [decision-making process][consensus], with appropriate [notice][] and [record keeping][records].
Expand Down Expand Up @@ -126,4 +126,4 @@ Certain critical actions (anything requiring a Supermajority vote) are reserved
[consensus]: ./5-decision-making.md#general-decision-making
[elections]: ./5-decision-making.md#elections
[notice]: ./6-notice-records.md#notice
[records]: ./6-notice-records.md#record-keeping
[records]: ./6-notice-records.md#record-keeping
2 changes: 1 addition & 1 deletion bylaws/4-cf-advisory-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ However, the Advisory Board plays a crucial role in shaping the foundation's dir
An up-to-date list of Advisory Board representatives will be maintained in the `advisory-board` [CONTACTS.yaml][] attribute.

[membership]: ./2-cf-membership.md
[CONTACTS.yaml]: https://github.com/commonhaus/foundation-draft/blob/main/CONTACTS.yaml
[CONTACTS.yaml]: https://github.com/commonhaus/foundation-draft/blob/main/CONTACTS.yaml
Loading

0 comments on commit fc45df2

Please sign in to comment.