Skip to content

Commit d45a7c4

Browse files
committed
content review with OSS WG
Signed-off-by: Paul Horton <phorton@sonatype.com>
1 parent f995770 commit d45a7c4

5 files changed

Lines changed: 42 additions & 15 deletions

File tree

content/en/docs/contributing/_index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ weight: 10
88

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

11-
{{% 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 %}}
12-
1311
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.
1412

1513
- **💡Want to discuss an idea?**
1614
*Read our guide on discussions and ideas [here]({{< ref "/docs/contributing/discussing-ideas" >}}).*
15+
1716
- **🪲 Want to report a bug or issue?**
1817
*Read our guide on issue reporting [here]({{< ref "/docs/contributing/reporting-issues" >}}).*
18+
1919
- **🧑‍💻 Want to contribute a change?**
20-
*Read our guide on sumitting contributions [here]({{< ref "/docs/contributing/submitting" >}}).*
20+
*Read our guide on sumitting contributions [here]({{< ref "/docs/contributing/submitting" >}}).*
21+
22+
{{% 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 %}}

content/en/docs/contributing/discussing-ideas.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ title: Discussing Ideas
66
weight: 10
77
---
88

9-
{{% pageinfo %}}
10-
This is a placeholder page that shows you how to use this template site.
11-
{{% /pageinfo %}}
9+
Ideas are great 💡
10+
11+
If you want to raise one, or join the discussion, we recommend all projects use GitHub Discussions.
12+
13+
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.

content/en/docs/contributing/reporting-issues.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,16 @@ title: Reporting Issues or Bugs
66
weight: 10
77
---
88

9-
{{% 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 %}}
9+
{{% 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 %}}
10+
11+
Whilst these open source efforts are supported by Sonatype Contributors, these Open Source Projects are not officially supported through Sonatype's commercial support channels.
12+
13+
Please review the latest pull requests, issues, and commits to understand a projects readiness for contribution and use.
14+
15+
File suggestions and requests on the Sonatype Open Source Project in question using GitHub Issues, so that the community can pitch in.
16+
17+
**DO** use or contribute to a Sonatype Open Source Project according to your organization's policies and your own risk tolerance.
18+
19+
**DON'T** file Sonatype support tickets related to a Sonatype Open Source Project — it won't reach the right people that way.
20+
21+
Last but not least of all - have fun!

content/en/docs/contributing/submitting.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,15 @@ title: Submitting a Contribution
66
weight: 10
77
---
88

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

11-
1. Have a singular purpose, and that is backed by one or more GitHub Issues in the project
12-
2. Are clear
13-
3. Have appropriate test coverage for the Pull Requests purpose
11+
Please ensure they meet these guidelines:
12+
13+
1. Has a clear and singular purpose
14+
2. It is backed by one or more GitHub Issues in the project
15+
3. Has appropriate test coverage for the Pull Requests purpose (if you add or modify functionality, make sure you add tests for this!)
1416
4. Meet the Projects Code Style Convention and Contribution Guidelines (see `CONTRIBUTING.md` in the specific Project)
15-
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)
1617

17-
{{< alert color="warning" >}}Contributions that don't meet the above requirements will not be accepted.{{< /alert >}}
18+
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).
19+
20+
{{< alert color="warning" >}}Contributions that don't meet the above requirements unfortunately cannot be accepted.{{< /alert >}}

content/en/docs/new-project/_index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@ title: Starting a New Project
66
weight: 20
77
---
88

9-
{{< alert title="Note" >}}Only Sonatype Employees can execute the below procedure to create new Project within the Sonatype Open Source Community.{{< /alert >}}
9+
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).
10+
11+
{{< alert title="Note" >}}Only Organizational Owners can execute the below procedure to create new Project within the Sonatype Open Source Community.{{< /alert >}}
1012

1113
## Prerequisites
1214

1315
- Ensure you have defined a clear purpose for the new project
16+
- To be a maintanier or owner of a project, you need to have previously contributed to another Sonatype Open Source Project
17+
18+
{{< alert title="Info" >}}
19+
Having contributed previously means you'll have signed our CLA and understand our Community workflows.
20+
{{< /alert >}}
1421

1522
## Creating the Project
1623

@@ -21,4 +28,5 @@ weight: 20
2128

2229
### GitHub Repository Configuration
2330

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

0 commit comments

Comments
 (0)