From 70d0cfa8d0cb169b22d5c588cd9f4135fd495d65 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Fri, 3 Oct 2025 02:32:56 +0100 Subject: [PATCH] Fix Markdown - governance.md: Fix contributors actions list not being rendered properly - index.md: Make URLs clickable - people.md: Make URLs clickable and fix heading level - mkdocs.yml: Codemeta -> CodeMeta Signed-off-by: Arthit Suriyawongkul --- Chapters/governance.md | 38 +++++++++++++++++++++++--------------- Chapters/index.md | 21 ++++++++++++--------- Chapters/people.md | 18 +++++++++--------- mkdocs.yml | 5 ++--- 4 files changed, 46 insertions(+), 36 deletions(-) diff --git a/Chapters/governance.md b/Chapters/governance.md index d12ce3a..cc3e826 100644 --- a/Chapters/governance.md +++ b/Chapters/governance.md @@ -1,17 +1,19 @@ -# CodeMeta Project Governance +# CodeMeta Project Governance + The CodeMeta governance model is based on the template provided by Meritocratic governance model by Ross Gardler and Gabriel Hanganu is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. ## 1. Introduction The CodeMeta Project entails the development and maintenance of the CodeMeta vocabulary, crosswalk table, website, software and other related content. Activities of the project might also include outreach activities to promote the use of CodeMeta by the broader community and ecosystem. - ## 2. Overview This is a meritocratic, consensus-based community project. Anyone with an interest in the project can join the community, contribute to the project design and participate in the decision making process. This document describes how that participation takes place and how to set about earning merit within the project community. ## 3. Roles And Responsibilities + ### 3.1 Users + Users are community members who have a need for the project. They are the most important members of the community and without them the project would have no purpose. Anyone can be a user; there are no special requirements. The project asks its users to participate in the project and community as much as possible. User contributions enable the project team to ensure that they are satisfying the needs of those users. Common user contributions include (but are not limited to): @@ -24,25 +26,27 @@ The project asks its users to participate in the project and community as much a Users who continue to engage with the project and its community will often become more and more involved. Such users may find themselves becoming contributors, as described in the next section. ### 3.2 Contributors + Contributors are community members who contribute in concrete ways to the project. Anyone can become a contributor, and contributions can take many forms, as detailed in a separate document. There is no expectation of commitment to the project, no specific skill requirements and no selection process. In addition to their actions as users, contributors may also find themselves doing one or more of the following: -supporting new users (existing users are often the best people to support new users) -* reporting bugs -* identifying requirements for new terms -* providing graphics and web design -* programming -* assisting with project infrastructure -* writing documentation -* fixing bugs -* adding features +- supporting new users (existing users are often the best people to support new users) +- reporting bugs +- identifying requirements for new terms +- providing graphics and web design +- programming +- assisting with project infrastructure +- writing documentation +- fixing bugs +- adding features Contributors engage with the project through the issue tracker and mailing list, or by writing or editing documentation. They submit changes to the project itself via patches, which will be considered for inclusion in the project by existing committers (see next section). The developer mailing list is the most appropriate place to ask for help when making that first contribution. As contributors gain experience and familiarity with the project, their profile within, and commitment to, the community will increase. At some stage, they may find themselves being nominated for committership. ### 3.3 Committers + Committers are community members who have shown that they are committed to the continued development of the project through ongoing engagement with the community. Committership allows contributors to more easily carry on with their project related activities by giving them direct access to the project’s resources. That is, they can make changes directly to project outputs, without having to submit changes via patches. This does not mean that a committer is free to do what they want. In fact, committers have no more authority over the project than contributors. While committership indicates a valued member of the community who has demonstrated a healthy respect for the project’s aims and objectives, their work continues to be reviewed by the community before acceptance in an official release. The key difference between a committer and a contributor is when this approval is sought from the community. A committer seeks approval after the contribution is made, rather than before. @@ -55,11 +59,12 @@ New committers can be nominated by any existing committer. Once they have been n Nominees may decline their appointment as a committer. However, this is unusual, as the project does not expect any specific time or resource commitment from its community members. The intention behind the role of committer is to allow people to contribute to the project more easily, not to tie them in to the project in any formal way. -It is important to recognise that commitership is a privilege, not a right. That privilege must be earned and once earned it can be removed by the PMC (see next section) in extreme circumstances. However, under normal circumstances committership exists for as long as the committer wishes to continue engaging with the project. +It is important to recognise that committership is a privilege, not a right. That privilege must be earned and once earned it can be removed by the PMC (see next section) in extreme circumstances. However, under normal circumstances committership exists for as long as the committer wishes to continue engaging with the project. A committer who shows an above-average level of contribution to the project, particularly with respect to its strategic direction and long-term health, may be nominated to become a member of the PMC. This role is described below. ### 3.4 Project management committee + The project management committee consists of those individuals identified as ‘project owners’ on the development site. The PMC has additional responsibilities over and above those of a committer. These responsibilities ensure the smooth running of the project. PMC members are expected to review code contributions, participate in strategic planning, approve changes to the governance model and manage the copyrights within the project outputs. Members of the PMC do not have significant authority over other members of the community, although it is the PMC that votes on new committers. It also makes decisions when community consensus cannot be reached. In addition, the PMC has access to the project’s private mailing list and its archives. This list is used for sensitive issues, such as votes for new committers and legal matters that cannot be discussed in public. It is never used for project management or planning. @@ -67,32 +72,34 @@ Members of the PMC do not have significant authority over other members of the c Membership of the PMC is by invitation from the existing PMC members. A nomination will result in discussion and then a vote by the existing PMC members. PMC membership votes are subject to consensus approval of the current PMC members. ### 3.5 PMC Chair + The PMC Chair is a single individual, voted for by the PMC members. Once someone has been appointed Chair, they remain in that role until they choose to retire, or the PMC casts a two-thirds majority vote to remove them. The PMC Chair has no additional authority over other members of the PMC: the role is one of coordinator and facilitator. The Chair is also expected to ensure that all governance processes are adhered to, and has the casting vote when the project fails to reach consensus. ## 4. Support + All participants in the community are encouraged to provide support for new users within the project management infrastructure. This support is provided as a way of growing the community. Those seeking support should recognise that all support activity within the project is voluntary and is therefore provided as and when time allows. A user requiring guaranteed response times or results should therefore seek to purchase a support contract from a community member. However, for those willing to engage with the project on its own terms, and willing to help support other users, the community support channels are ideal. ## 5. Contribution Process + Anyone can contribute to the project, regardless of their skills, as there are many ways to contribute. For instance, a contributor might be active on the project mailing list and issue tracker, or might supply patches. The various ways of contributing are described in more detail in a separate document. The developer mailing list is the most appropriate place for a contributor to ask for help when making their first contribution. ## 6. Decision Making Process + Decisions about the future of the project are made through discussion with all members of the community, from the newest user to the most experienced PMC member. All non-sensitive project management discussion takes place on the project contributors’ mailing list. Occasionally, sensitive discussion occurs on a private list. In order to ensure that the project is not bogged down by endless discussion and continual voting, the project operates a policy of lazy consensus. This allows the majority of decisions to be made without resorting to a formal vote. -Lazy consensus -Decision making typically involves the following steps: +Lazy consensus decision making typically involves the following steps: 1. Proposal 2. Discussion 3. Vote (if consensus is not reached through discussion) 4. Decision - Any community member can make a proposal for consideration by the community. In order to initiate a discussion about a new idea, they should send an email to the project contributors’ list or submit a patch implementing the idea to the issue tracker (or version-control system if they have commit access). This will prompt a review and, if necessary, a discussion of the idea. The goal of this review and discussion is to gain approval for the contribution. Since most people in the project community have a shared vision, there is often little need for discussion in order to reach consensus. In general, as long as nobody explicitly opposes a proposal or patch, it is recognised as having the support of the community. This is called lazy consensus - that is, those who have not stated their opinion explicitly have implicitly agreed to the implementation of the proposal. @@ -102,4 +109,5 @@ Lazy consensus is a very important concept within the project. It is this proces For lazy consensus to be effective, it is necessary to allow at least 72 hours before assuming that there are no objections to the proposal. This requirement ensures that everyone is given enough time to read, digest and respond to the proposal. This time period is chosen so as to be as inclusive as possible of all participants, regardless of their location and time commitments. ## 7. Voting + Not all decisions can be made using lazy consensus. Issues such as those affecting the strategic direction or legal standing of the project must gain explicit approval in the form of a vote. Every member of the community is encouraged to express their opinions in all discussion and all votes. However, only project committers and/or PMC members (as defined above) have binding votes for the purposes of decision making. A separate document on the voting within a meritocratic governance model describes in more detail how voting is conducted in projects following the practice established within the Apache Software Foundation. diff --git a/Chapters/index.md b/Chapters/index.md index 244eda6..70e7f52 100644 --- a/Chapters/index.md +++ b/Chapters/index.md @@ -8,29 +8,32 @@ layout: home # CodeMeta Governance ## What's CodeMeta + CodeMeta is an initiative in search of creating better semantic artefacts for software in general and Research Software in particular. This initiative has created: -- The CodeMeta vocabulary - A subset of schema.org + +- The CodeMeta vocabulary - A subset of Schema.org - The CodeMeta crosswalk table - mapping the metadata landscape Additionally, there is a thriving academic community dedicated to discussing and developing software metadata in the context of this initiative. +## The CodeMeta community -## The codeMeta community The CodeMeta community oversees development of the following: -- the CodeMeta vocabulary: https://github.com/codemeta/codemeta -- the CodeMeta crosswalk table: https://github.com/codemeta/codemeta -- the CodeMeta website: https://github.com/codemeta/codemeta.github.io -- the CodeMeta generator: https://github.com/codemeta/codemeta-generator +- the CodeMeta vocabulary: +- the CodeMeta crosswalk table: +- the CodeMeta website: +- the CodeMeta generator: ## Links -- The website: https://codemeta.github.io/ -- The hosted CodeMeta generator: https://codemeta.github.io/codemeta-generator/ + +- The website: +- The hosted CodeMeta generator: This website is generated directly from the [codemeta/governance repository](https://github.com/codemeta/governance) -Copyright © 2022-2023 Codemeta Contributors. +Copyright © 2022-2023 CodeMeta Contributors. This work is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). All other rights are expressly reserved. diff --git a/Chapters/people.md b/Chapters/people.md index 9142f77..43c5d0c 100644 --- a/Chapters/people.md +++ b/Chapters/people.md @@ -1,34 +1,34 @@ # People Link to the CONTRIBUTORS file on the codemta/codemeta repository: -https://github.com/codemeta/codemeta/blob/master/CONTRIBUTORS.MD + For the full list of contributors in the CodeMeta community. -### Porject Management Committee (PMC) +## Porject Management Committee (PMC) -The current pmc members are, in first name alphabetical order: +The current PMC members are, in first name alphabetical order: -| Name | Institution | GitHub | +| Name | Institution | GitHub | |------------------|------------------------| --------| | Abby Cabunoc Mayes | Mozilla Science Lab | [@acabunoc](http://github.com/acabunoc) | | Arfon Smith | GitHub | [@arfon](http://github.com/arfon) | -| Carl Boettiger | UC Berkeley | [@cboettig](http://github.com/cboettig) | -| Daniel Garijo | Universidad Politécnica de Madrid | [@dgarijo](https://github.com/dgarijo) | +| Carl Boettiger | UC Berkeley | [@cboettig](http://github.com/cboettig) | +| Daniel Garijo | Universidad Politécnica de Madrid | [@dgarijo](https://github.com/dgarijo) | | Matthew B. Jones | NCEAS, UC Santa Barbara | [@mbjones](http://github.com/mbjones) | | Morane Gruenpeter |Software Heritage | [@moranegg](https://github.com/moranegg) | | Thomas Morrell | Caltech Library | [@tmorell](https://github.com/tmorrell) | | Valentin Lorentz | Software Heritage | [@progval](https://github.com/progval) | -Following the CodeMeta PMC -[vote in May 2023](https://groups.google.com/g/codemeta-pmc/c/ccSSP57A7tI/m/rg4WJVa5AQAJ), +Following the CodeMeta PMC +[vote in May 2023](https://groups.google.com/g/codemeta-pmc/c/ccSSP57A7tI/m/rg4WJVa5AQAJ), the current chair of the PMC is Morane Gruenpeter. For more information about governance structure [here](./governance.md) ### Committers -The current committers are, in first name alphabetical order: +The current committers are, in first name alphabetical order: - abbycabs - cboettig diff --git a/mkdocs.yml b/mkdocs.yml index ea8598c..a73c834 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,13 +1,12 @@ -site_name: Codemeta Governance +site_name: CodeMeta Governance docs_dir: Chapters theme: readthedocs use_directory_urls: true nav: - - 'Governance': governance/ - 'People': people/ -copyright: Copyright © 2022-2023 - Codemeta Contributors. +copyright: Copyright © 2022-2023 - CodeMeta Contributors. markdown_extensions: - codehilite: