Skip to content

Commit

Permalink
CFC/CF Council usage consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
ebullient committed Nov 11, 2023
1 parent a15943a commit 3f11424
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 43 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/markdown-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ jobs:
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.mlc_config.json'

- id: website-bump
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh workflow run -R commonhaus/commonhaus.github.io gh-pages.yml
4 changes: 2 additions & 2 deletions BOOTSTRAPPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ status: draft

This document outlines the interim procedures and commitments during the foundation's initial establishment phase. It provides guidelines for project commitments, ensuring mutual trust and flexibility until the foundation reaches a stable state.

[cc]: GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[cfc]: GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[cc-dm]: GOVERNANCE.md#decision-making-and-voting

## 1. Preliminary Commitments
Expand All @@ -25,7 +25,7 @@ After the foundation is formally organized, there is a *Formation Period* during

During this time, projects can monitor participation levels and foundational processes.

- The initial [CF Council][cc] will contain representatives from all participating projects.
- The initial [CF Council][cfc] will contain representatives from all participating projects.
- Decisions should follow (and refine) the [CF decision making process][cc-dm].

## 4. Trademark Donations and Other Commitments
Expand Down
18 changes: 9 additions & 9 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ The Commonhaus Foundation (CF), and every project within it, needs a clear and e
## Contact information

- **Project Issues:** Each CF project will define a `CODE_OF_CONDUCT.md`. For issues related to a project, start there.
- **Founation Issues:** Issues related to the CF should be sent to `report@mailing-list` for [review](#respond-to-a-coc-issue) by the [Commonhaus Foundation Council][cc] (CFC).
- The [CFC][cc] will follow [CF CoC procedures][coc-reports] when handling CoC reports.
- **Founation Issues:** Issues related to the CF should be sent to `report@mailing-list` for [review](#respond-to-a-coc-issue) 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.
- **Escalations:** [Escalations](#escalate-an-issue) should be sent to `coc-escalation@mailing-list` 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.

[cc]: GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[cfc]: GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[cc-dm]: GOVERNANCE.md#decision-making-and-voting
[cocp]: #code-of-conduct-panel "Code of Conduct Panel"
[membership]: https://github.com/commonhaus/foundation-draft/blob/main/MEMBERS.yaml "Members"
Expand Down Expand Up @@ -68,7 +68,7 @@ This does not mean that decisions are set in stone. CF projects and the CFC are
### Report an issue

- Each CF project is free to implement enforcement of the CoC using processes appropriate for the size and scope of the project. CoC enforcement processes and contact methods must be defined in the projects' `CODE_OF_CONDUCT.md`.
- For CF repositories that do not specify their own `CODE_OF_CONDUCT.md`, send your report to `report@mailing-list`. The [CFC][cc] will receive these reports.
- For CF repositories that do not specify their own `CODE_OF_CONDUCT.md`, send your report to `report@mailing-list`. The CFC will receive these reports.

Confidentiality is of utmost importance. We also understand that the person reporting the issue (**reporter**) may not be the individual directly affected or harmed (**target**). In such cases, communication will primarily be with the reporter unless the target explicitly gives permission. Personal details of the reporter (and the target if they differ) will not be disclosed without permission.

Expand All @@ -86,9 +86,9 @@ Access to the private repository should be restricted to individuals charged wit

### Escalate an issue

We expect most reports to be handled by the processes put in place by a project or the [CFC][cc].
We expect most reports to be handled by the processes put in place by a project or the CFC.

The CF maintains the [CoCP][cocp] to manage escalation when a reporter (a) believes that a report to a member project or the [CFC][cc] has not been properly handled, or (b) does not feel comfortable reporting an issue through the standard process.
The CF maintains the CoCP to manage escalation when a reporter (a) believes that a report to a member project or the CFC has not been properly handled, or (b) does not feel comfortable reporting an issue through the standard process.

Email `coc-escalation@mailing-list` to escalate an issue to the CoCP. The CoCP will meet to review submitted reports as described in [CF CoC procedures][coc-reports]

Expand All @@ -103,15 +103,15 @@ Members of the CoCP will be documented in the `cocp-panel` [MEMBERS.yaml][member

## Handling Reports and Escalations

This section describes the process and roles for handling Code of Conduct (CoC) reports and escalations for both the CF Council (CFC) and the CF Code of Conduct Panel (CoCP).
This section describes the process and roles for handling Code of Conduct (CoC) reports and escalations for both the CFC and the CF Code of Conduct Panel (CoCP).

### Conflict of Interest

Any member of the CFC or CoCP who is involved in the report must recuse themselves from the discussions.

### Reports to `report@mailing-list`

All members of the [CFC][cc] are subscribed to the `report@mailing-list` mailing list.
All members of the CFC are subscribed to the `report@mailing-list` mailing list.

We understand that the person reporting the issue (**reporter**) may not be the individual directly affected or harmed (**target**). In such cases, communication will primarily be with the reporter unless the target explicitly gives permission.

Expand All @@ -125,7 +125,7 @@ We understand that the person reporting the issue (**reporter**) may not be the

### Reports to `coc-escalation@mailing-list`

All members of the [CoCP][cocp] are subscribed to the `coc-escalation@mailing-list` mailing list.
All members of the CoCP are subscribed to the `coc-escalation@mailing-list` mailing list.

The CoCP will follow the same overall procedure as the CFC, with the following changes:

Expand Down
22 changes: 15 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,24 @@ While there might not be traditional code here, we treat our documents with the

## Getting Started

### 1. Open an Issue
### 1. Consider Opening an Issue (Optional for Minor Changes)

Before making any changes, open an issue in the repository. This helps us track and discuss the proposed changes, be it a typo, an enhancement, or a substantial amendment. Describe your issue in detail, and tag any relevant maintainers or teams.
While opening an issue is generally recommended for tracking and discussing proposed changes, it's not always required, especially for trivial modifications.

- For smaller changes or straightforward fixes, you can directly initiate a pull request (PR) where discussions can also take place.
- For more significant updates or enhancements, opening an issue helps in organizing and deliberating the changes with the community and relevant teams.

### 2. Fork the Repository

Fork the repository to your own GitHub account. This will allow you to work on your proposed changes independently before submitting them for review.
Fork the repository to your own GitHub account.
This will allow you to work on your proposed changes independently before submitting them for review.

## Making Changes

### 1. Be Clear and Concise

Our documents aim to be direct and developer-friendly. We value clarity, so please ensure your changes or additions reflect that.
Our documents aim to be direct and developer-friendly.
We value clarity, so please ensure your changes or additions reflect that.

### 2. Adhere to the Format

Expand All @@ -39,11 +44,12 @@ git commit -m "Fixed typo in section X, resolves #123"

### 1. Create a Pull Request (PR)

Once you're ready to submit your changes, create a new pull request from your fork. Ensure the PR description is clear about the changes you've made.
Once you're ready to submit your changes, create a new pull request from your fork.
Ensure the PR description is clear about the changes you've made.

### 2. Await Review

The Commonhaus Foundation Council (CFC) and, when necessary, Foundation-retained legal counsel will review your PR.
One of the `CODEOWNERS` will review your PR.
We might request further clarifications, changes, or provide feedback.

### 3. Address Feedback
Expand All @@ -61,4 +67,6 @@ We appreciate your patience as we ensure that all content aligns with the founda
Every contribution, be it small or large, helps us maintain and improve this repository.
Your willingness to help is genuinely appreciated.

For any questions or further information, don't hesitate to reach out to us. Happy contributing!
For any questions or further information, don't hesitate to reach out to us.

Happy contributing!
9 changes: 5 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The Advisory Board does not have decision-making authority but plays a crucial r

- **Diversity of Insight**: Where possible, organizations are encouraged to appoint representatives who bring different types of expertise or experience, such as a managerial and a technical perspective, to contribute to a well-rounded advisory process.

- **Meetings**: The Advisory Board convenes with the CF Council semi-annually, providing a platform for collaborative review and feedback on the CF's direction, initiatives, and impact on the industry.
- **Meetings**: The Advisory Board convenes with the CFC semi-annually, providing a platform for collaborative review and feedback on the CF's direction, initiatives, and impact on the industry.

- **Communication**: Representatives are expected to actively communicate the needs and concerns of their organizations, while also conveying the goals and achievements of the CF to their respective constituencies.

Expand Down Expand Up @@ -119,9 +119,10 @@ A Voting CFC member may choose to participate in any vote through abstention.
When seeking consensus in mailing lists, it is important to leave enough time (at least 72-hours) for everyone to read the email and respond with opinions and objections.

CFC members should consider the following when drafting consensus-seeking email:
- Use a leading indicator (`[DISCUSS]` or an emoji like 🗳️) to mark consensus-seeking email
- Use a clear subject line that summarizes the topic
- If there is a time constraint to the decision, include it in the subject.

- Use a leading indicator (`[DISCUSS]` or an emoji like 🗳️) to mark consensus-seeking email
- Use a clear subject line that summarizes the topic
- If there is a time constraint to the decision, include it in the subject.

It is customary for the initiator to post a summary once it appears that consensus has been reached, to ensure that their understanding is accurate.

Expand Down
18 changes: 9 additions & 9 deletions governance/conflict-of-interest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ As a nonprofit organization, CF is committed to the responsible stewardship of i
This policy is designed to protect the interests of the Commonhaus Foundation (CF) when potentially beneficial actions or transactions might intersect with the private interests of a director, officer, or key person.
Additionally, it ensures compensation fairness for any staff or contractors hired by CF, which operates primarily as a volunteer organization.

This policy applies to all individuals with decision-making authority within the CF ("you"), including CF Council and Advisory Board members, and extends to CF members and project leaders when their personal interests may influence Foundation activities.
This policy applies to all individuals with decision-making authority within the CF ("you"), including CF Council (CFC) and Advisory Board members, and extends to CF members and project leaders when their personal interests may influence Foundation activities.

## Identifying Conflicts of Interest

Expand All @@ -28,34 +28,34 @@ When in doubt, it is safer to disclose a potential conflict of interest.

### Immediate Disclosure

All potential conflicts should be disclosed to the designated official or office within the CF Council immediately upon recognition.
All potential conflicts should be disclosed to the designated official or office within the CFC immediately upon recognition.

### Annual Disclosure

You are required to submit an annual statement of potential conflicts, and for CF Council members, also before your initial appointment.
You are required to submit an annual statement of potential conflicts, and for CFC members, also before your initial appointment.

## Determining Whether a Conflict of Interest Exists

The CF Council, or a designated committee, will review disclosures to determine if a conflict exists. The involved individual will recuse themselves from the decision-making process.
The CFC, or a designated committee, will review disclosures to determine if a conflict exists. The involved individual will recuse themselves from the decision-making process.

The CF Council will consider whether the potential conflict might affect CF’s transactions or reputation and take appropriate action.
The CFC will consider whether the potential conflict might affect CF’s transactions or reputation and take appropriate action.

## Procedures for Addressing a Conflict of Interest

The CF Council may gather facts from the involved party but will deliberate and decide on the matter in their absence.
The CFC may gather facts from the involved party but will deliberate and decide on the matter in their absence.

For transactions involving significant interests, the CF Council will seek alternatives and require a consensus for approval, with all decisions being documented.
For transactions involving significant interests, the CFC will seek alternatives and require a consensus for approval, with all decisions being documented.

## Minutes and Documentation

The minutes of the CF Council meetings will include details of discussions regarding conflicts, including names, interests, and the rationale for decisions.
The minutes of the CFC meetings will include details of discussions regarding conflicts, including names, interests, and the rationale for decisions.

## Prohibited Acts

CF will not make loans to any Council members, officers, or key persons.

## Procedures for Determining Compensation

When hiring staff or paying for contract work, the CF Council will reference industry standards to ensure compensation is fair and justified. The process will be transparent and fully documented.
When hiring staff or paying for contract work, the CFC will reference industry standards to ensure compensation is fair and justified. The process will be transparent and fully documented.

All individuals will abstain from discussions or votes concerning their own compensation or that of those closely associated with them.
4 changes: 2 additions & 2 deletions governance/ip-policy-guidance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ status: draft
This guide simplifies the [Commonhaus Foundation (CF) IP Policy][IP Policy] for easier implementation.

[IP Policy]: ip-policy.md
[cc]: ../GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[cfc]: ../GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[standard website footer]: website-footer.md "Commonhaus Foundation website footers"

## Basic IP Requirements
Expand All @@ -30,7 +30,7 @@ This guide simplifies the [Commonhaus Foundation (CF) IP Policy][IP Policy] for

## Obtaining an Exemption

If the [IP Policy][] doesn't cater to your project's needs, request special permission from the [CF Council (CFC)][cc].
If the [IP Policy][] doesn't cater to your project's needs, request special permission from the [CF Council][cfc] (CFC).

[Steps to request an exemption TBD]

Expand Down
6 changes: 3 additions & 3 deletions governance/ip-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ status: draft

The Commonhaus Foundation (CF) oversees multiple individual projects, referred to as “Projects”. Contributions to these Projects are governed by this policy and each Project's chosen license, known as the “Project Code License”.

[cc]: ../GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[cfc]: ../GOVERNANCE.md#commonhaus-foundation-council "Commonhaus Foundation Council"
[IP Policy Guidance]: ip-policy-guidance.md "Commonhaus Foundation IP Policy Guidance"

1. **License Options:** Projects can select from approved licenses:
Expand All @@ -14,7 +14,7 @@ The Commonhaus Foundation (CF) oversees multiple individual projects, referred t
- [The 2-Clause BSD License](https://opensource.org/license/bsd-2-clause/)
- [The 3-Clause BSD License](https://opensource.org/license/bsd-3-clause/)

Other open source licenses require [Commonhaus Foundation Council (CFC)][cc] approval.
Other open source licenses require [Commonhaus Foundation Council][cfc] (CFC) approval.

2. **Collaborations with Upstream Projects:** When collaborating with external open source projects (“Upstream Projects”), Projects must:

Expand All @@ -36,6 +36,6 @@ The Commonhaus Foundation (CF) oversees multiple individual projects, referred t

For detailed guidance on implementing this policy, refer to the [IP Policy Guidance][].

[CC BY 4.0]: http://creativecommons.org/licenses/by/4.0/ "Creative Commons Attribution 4.0 International License (CFC BY 4.0)"
[CC BY 4.0]: http://creativecommons.org/licenses/by/4.0/ "Creative Commons Attribution 4.0 International License (CC BY 4.0)"
[MIT]: https://opensource.org/license/mit/ "The MIT License"
[DCO]: http://developercertificate.org/
2 changes: 1 addition & 1 deletion governance/trademark-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,5 +145,5 @@ The Commonhaus Foundation may modify or update this Trademark Policy as needed.

This work is inspired by [The OpenJS Foundation Trademark Policy](https://openjsf.org/wp-content/uploads/sites/84/2021/01/OpenJS-Foundation-Trademark-Policy-2021-01-12.docx.pdf).
It is licensed under a Creative
Commons Attribution 4.0 International license (“CFC BY 4.0”, available at
Commons Attribution 4.0 International license (“CC BY 4.0”, available at
<https://creativecommons.org/licenses/by/4.0>).
Loading

0 comments on commit 3f11424

Please sign in to comment.