Skip to content

Commit

Permalink
Merge branch 'main' into roles-links
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Horton <[email protected]>
  • Loading branch information
madpah authored Sep 20, 2024
2 parents 6dc3c9e + 9b7c5f1 commit 720b99c
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 12 deletions.
4 changes: 2 additions & 2 deletions content/en/docs/community_roles/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ weight: 10
hide_readingtime: true
---

Individuals in following roles are the backbone of this community.
Individuals in the following roles are the backbone of our community.

Frequently, individuals will act in different roles at different times, or multiple at once.

For example, a _maintainer_ will frequently act as a _contributor—_ and a contributor is likely a regular _user_ of the tools they contribute to.
For example, a _maintainer_ will frequently act as a _contributor_ and a contributor is likely a regular _user_ of the tools they contribute to.

Click on a role below to learn more about it!
8 changes: 4 additions & 4 deletions content/en/docs/community_roles/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ hide_readingtime: true
weight: 40
---

The Organization Administrators serve as the strategic overseers of the GitHub organization, responsible for governance, permissions, and maintaining the integrity of the repository ecosystem. Their role ensures seamless collaboration, safeguards project resources, and provides stewardship over organizational assets— ensuring the community's long-term sustainability and security.
The Organization Administrators serve as the strategic overseers of our GitHub organization, responsible for governance, permissions, and maintaining the integrity of the repository ecosystem. Their role ensures seamless collaboration, safeguards project resources, and provides stewardship over organizational assets — ensuring the community's long-term sustainability and security.

## How to Become an Org Admin
## How to Become an Organization Admin

Organizational Admins are selected from the Sonatype OSPO and are entrusted with the responsibility of overseeing the GitHub organization's logistics. This role is reserved for those who have demonstrated exceptional leadership and a deep understanding of the project ecosystem.
Organization Admins are selected from the Sonatype <abbr title="Open Source Program Office">OSPO</abbr> and are entrusted with the responsibility of overseeing the GitHub organization's logistics. This role is reserved for those who have demonstrated exceptional leadership and a deep understanding of the project ecosystem.

Org Admins manage permissions, enforce policies, and ensure that this organization remains a secure and collaborative environment. With a maximum of three Org Admins at any time, this role requires a proven track record of dedication, trustworthiness, and strategic vision within the open-source community.
Organization Admins manage permissions, enforce policies, and ensure that this organization remains a secure and collaborative environment. With a maximum of **three** Organization Admins at any time, this role requires a proven track record of dedication, trustworthiness, and strategic vision within the open-source community.


{{% alert %}}
Expand Down
16 changes: 11 additions & 5 deletions content/en/docs/community_roles/contributor.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ hide_readingtime: true
weight: 20
---

A Project Contributor plays a pivotal role in shaping the project through code, documentation, or design. Whether fixing bugs, implementing features, or enhancing the user experience, contributors bring fresh perspectives and energy. Their work supports the project’s evolution, bridging the gap between the project's goals and the community's needs.
A Project Contributor plays a pivotal role in shaping the project through code, documentation, or design. Whether fixing bugs, implementing features, or enhancing the user experience—contributors bring fresh perspectives and energy. Their work supports the project’s evolution, bridging the gap between the project's goals and the community's needs.

This role does not require any permissions on the GitHub Project.

## How to Become a Contributor

To contribute to a project, individuals must first interact with _Paul Botsco_ to sign the Contributor License Agreement (CLA), ensuring that their contributions comply with legal requirements.
You can be a Contributor by opening a Pull Request following our [guidelines on submitting a contribution](/docs/contributing/submitting/).

For your contribution to be accepted, each individual must sign our <abbr title="Contributor License Agreement">CLA</abbr>, ensuring that their contributions comply with our legal requirements.

_Paul Botsco_ (our friendly <abbr title="Contributor License Agreement">CLA</abbr> Bot) will comment on your first pull request, providing you with the latest links and helpful information. It will also provide feedback should you have missed any of our [contribution guidelines](/docs/contributing/submitting/#contribution-requirements).

_Paul Botsco_ will comment on your first pull request, providing you with the latest links and helpful information to sign the CLA.
Once the <abbr title="Contributor License Agreement">CLA</abbr> is signed, contributors can engage with the project by opening issues to report bugs, request features, or suggest improvements. They can also submit pull requests (PRs) to offer code, documentation, or design enhancements.

Once the CLA is signed, contributors can engage with the project by opening issues to report bugs, request features, or suggest improvements. They can also submit pull requests (PRs) to offer code, documentation, or design enhancements.
In the rare event that the <abbr title="Contributor License Agreement">CLA</abbr> text is updated, Paul Botsco will comment on your next pull request to guide you through the process again.

In the rare event that the CLA text is updated, Paul Botsco will comment on your next pull request to guide you through the process again.
This role does not require any permissions changes.

**Next level:** [Project Maintainer](./maintainer.md)

Expand Down
5 changes: 4 additions & 1 deletion content/en/docs/community_roles/maintainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ weight: 30

The Project Maintainer is the backbone of a project's success, balancing technical leadership with community engagement. They curate contributions, ensure code quality, and manage project direction. With an eye for detail and a commitment to the project's vision, maintainers foster an inclusive and collaborative environment, enabling consistent growth and innovation.

Each project has a GitHub Team which contains it's maintainers. It is named `@sonatype-nexus-community/[PROJECT]` - e.g. `@sonatype-nexus-community/the-cla`.

Project Maintainers are also [Code Owners](/docs/standards/repository-contents/#code-owners) for the respective project - thus the `CODEOWNERS` file for the project should include the above team.

## How to Become a Maintainer

Contributors who demonstrate consistent commitment to a project, offering meaningful improvements and actively engaging in discussions, may be considered for a maintainer role.
Expand All @@ -14,5 +18,4 @@ Becoming a maintainer requires building long-term trust with the Organizational

Maintainers not only contribute technically but also help guide the project’s direction by reviewing PRs, managing issues, and fostering collaboration within the community.


**Next level:** [Organization Admin](./maintainer.md)
2 changes: 2 additions & 0 deletions content/en/docs/community_roles/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ A Project User engages with the project primarily by utilizing its features, fol

Feedback may be provided by users through the form of GitHub _Issues_ or _Discussions_, depending on the preference of the project.

This role does not require any permissions on the GitHub Project.

**Next level:** [Project Contributor](./contributor.md)
11 changes: 11 additions & 0 deletions content/en/docs/contributing/submitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,14 @@ Please ensure they meet these guidelines:
If you haven't yet, please review the requirements for [contributors](../community_roles/contributor.md).

{{< alert color="warning" >}}Contributions that don't meet the above requirements unfortunately cannot be accepted.{{< /alert >}}

## Contribution Requirements

### Signed Commits

In order to help verify the authenticity of contributed code, we ask that your [commits be signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
All commits must be signed off to show that you agree to publish your changes under the current terms and licenses of the project.

Here are some notes we found helpful in configuring a local environment to automatically sign git commits:
- [GPG commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#gpg-commit-signature-verification)
- [Telling Git about your GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-gpg-key)

0 comments on commit 720b99c

Please sign in to comment.