Skip to content

Commit

Permalink
content review with OSS WG
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Horton <phorton@sonatype.com>
  • Loading branch information
madpah committed Aug 30, 2024
1 parent f995770 commit d45a7c4
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 15 deletions.
8 changes: 5 additions & 3 deletions content/en/docs/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ weight: 10

We thank you in advance for contributing to our Open Source Community!

{{% alert color="warning" %}}If you believe you have discovered a Security Issue please disclose it responsibly by following our [Responsible Disclosure Process](https://www.sonatype.com/report-a-security-vulnerability) for active projects.{{% /alert %}}

Contributions come is all shapes and sizes - and we welcome them all. We ask that for the benefit of the wider community the following guidelines are followed depending on the contribution you wish to make.

- **💡Want to discuss an idea?**
*Read our guide on discussions and ideas [here]({{< ref "/docs/contributing/discussing-ideas" >}}).*

- **🪲 Want to report a bug or issue?**
*Read our guide on issue reporting [here]({{< ref "/docs/contributing/reporting-issues" >}}).*

- **🧑‍💻 Want to contribute a change?**
*Read our guide on sumitting contributions [here]({{< ref "/docs/contributing/submitting" >}}).*
*Read our guide on sumitting contributions [here]({{< ref "/docs/contributing/submitting" >}}).*

{{% alert color="warning" %}}If you believe you have discovered a Security Issue please disclose it responsibly by following our [Responsible Disclosure Process](https://www.sonatype.com/report-a-security-vulnerability) for active projects.{{% /alert %}}
8 changes: 5 additions & 3 deletions content/en/docs/contributing/discussing-ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: Discussing Ideas
weight: 10
---

{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
{{% /pageinfo %}}
Ideas are great 💡

If you want to raise one, or join the discussion, we recommend all projects use GitHub Discussions.

Please make sure you follow our [Code of Conduct](https://github.com/sonatype-nexus-community/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
14 changes: 13 additions & 1 deletion content/en/docs/contributing/reporting-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,16 @@ title: Reporting Issues or Bugs
weight: 10
---

{{% alert color="warning" %}}If you believe you have discovered a Security Issue please disclose it responsibly by following our [Responsible Disclosure Process](https://www.sonatype.com/report-a-security-vulnerability) for active projects.{{% /alert %}}
{{% alert color="warning" %}}If you believe you have discovered a Security Issue please disclose it responsibly by following our [Responsible Disclosure Process](https://www.sonatype.com/report-a-security-vulnerability) for active projects.{{% /alert %}}

Whilst these open source efforts are supported by Sonatype Contributors, these Open Source Projects are not officially supported through Sonatype's commercial support channels.

Please review the latest pull requests, issues, and commits to understand a projects readiness for contribution and use.

File suggestions and requests on the Sonatype Open Source Project in question using GitHub Issues, so that the community can pitch in.

**DO** use or contribute to a Sonatype Open Source Project according to your organization's policies and your own risk tolerance.

**DON'T** file Sonatype support tickets related to a Sonatype Open Source Project — it won't reach the right people that way.

Last but not least of all - have fun!
15 changes: 9 additions & 6 deletions content/en/docs/contributing/submitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@ title: Submitting a Contribution
weight: 10
---

We welcome Pull Requests to our Community Projects - but please ensure they meet these guidelines:
We welcome contributions via Pull Requests to our Community Projects.

1. Have a singular purpose, and that is backed by one or more GitHub Issues in the project
2. Are clear
3. Have appropriate test coverage for the Pull Requests purpose
Please ensure they meet these guidelines:

1. Has a clear and singular purpose
2. It is backed by one or more GitHub Issues in the project
3. Has appropriate test coverage for the Pull Requests purpose (if you add or modify functionality, make sure you add tests for this!)
4. Meet the Projects Code Style Convention and Contribution Guidelines (see `CONTRIBUTING.md` in the specific Project)
5. Accept our Contributor License Agreement (CLA) if you have not previously done so (you'll be prompted on the Pull Request by our CLA Bot)

{{< alert color="warning" >}}Contributions that don't meet the above requirements will not be accepted.{{< /alert >}}
If you've not signed our latest Contributor License Agreement (CLA), you'll be prompted on the Pull Request by our [CLA Bot - PaulBotsco](https://github.com/sonatype-nexus-community/the-cla).

{{< alert color="warning" >}}Contributions that don't meet the above requirements unfortunately cannot be accepted.{{< /alert >}}
12 changes: 10 additions & 2 deletions content/en/docs/new-project/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,18 @@ title: Starting a New Project
weight: 20
---

{{< alert title="Note" >}}Only Sonatype Employees can execute the below procedure to create new Project within the Sonatype Open Source Community.{{< /alert >}}
You can share your idea for a new Project by starting a [Discussion here](https://github.com/orgs/sonatype-nexus-community/discussions/new?category=project-proposal).

{{< alert title="Note" >}}Only Organizational Owners can execute the below procedure to create new Project within the Sonatype Open Source Community.{{< /alert >}}

## Prerequisites

- Ensure you have defined a clear purpose for the new project
- To be a maintanier or owner of a project, you need to have previously contributed to another Sonatype Open Source Project

{{< alert title="Info" >}}
Having contributed previously means you'll have signed our CLA and understand our Community workflows.
{{< /alert >}}

## Creating the Project

Expand All @@ -21,4 +28,5 @@ weight: 20

### GitHub Repository Configuration

See our [GitHub Repository Configuration Standards]({{< ref "/docs/standards/github-repository" >}}).
See our [GitHub Repository Configuration Standards]({{< ref "/docs/standards/github-repository" >}}).

0 comments on commit d45a7c4

Please sign in to comment.