Copyedit of template and contributing docs

Signed-off-by: Stephen Augustus <[email protected]>

Author: justaugustus

.github/pull_request_template.md

@@ -1,71 +1,72 @@
-## Description
+# Description
 
-<!-- Briefly describe what this PR adds or changes -->
+<!-- Briefly describe what this pull request adds or changes. -->
 
-## Type of Change
+## Type of change
 
-<!-- Check all that apply -->
+<!-- Check all that apply. -->
+- [ ] Add a new tool/project
+- [ ] Add a new category
+- [ ] Documentation update e.g., fixing a broken link, updating an existing entry
+- [ ] Other (please describe above)
 
-- [ ] Adding a new tool/project
-- [ ] Adding a new category
-- [ ] Updating an existing entry
-- [ ] Fixing a broken link
-- [ ] Documentation update
-- [ ] Other (please describe):
-
-## For New Tools/Projects
-
-<!-- If you're adding a new tool or project, please complete this section -->
+<!-- If you're adding a new tool or project, please complete this section. -->
+## New tool/project
 
 ### Why is this tool/project needed?
 
-<!-- Explain the problem it solves or the gap it fills. How does it help organizations manage open source projects or OSPOs? -->
+<!--
+Explain the problem it solves or the gap it fills.
+How does it help organizations manage open source projects or OSPOs?
+-->
 
 ### Category Selection
 
 **Selected Category:** <!-- e.g., Code Reviews, GitHub Management, etc. -->
 
 **Why this category?**
 
-<!-- Explain why you chose this specific category. If the tool fits multiple categories, explain why this is the primary use case. -->
+<!--
+Explain why you chose this specific category.
+If the tool fits multiple categories, explain why this is the primary use case.
+-->
 
 ### Tool Uniqueness
 
-<!-- If similar tools already exist in the list, explain what makes this tool unique or complementary -->
+<!-- If similar tools already exist in the list, explain what makes this tool unique or complementary. -->
 
+<!-- If you're proposing a new category, please complete this section. -->
 ## For New Categories
 
-<!-- If you're proposing a new category, please complete this section -->
-
 ### Why is a new category needed?
 
-<!-- Explain what gap the new category would fill -->
+<!-- Explain what gap the new category would fill. -->
 
 ### Example Tools
 
-<!-- Provide at least 2-3 examples of tools that would fit in this category -->
+<!--
+Provide at least 2-3 examples of tools that would fit in this category.
 
 1. 
-2. 
-3. 
+1. 
+-->
 
 ### Category Positioning
 
-<!-- Suggest where the new category should be positioned in the list -->
+<!-- Suggest where the new category should be positioned in the list. -->
 
 ### Why existing categories are not suitable
 
-<!-- Explain why existing categories don't work for these tools -->
+<!-- Explain why existing categories don't work for these tools. -->
 
 ## Checklist
 
-<!-- Check all that apply -->
-
-- [ ] I have read the CONTRIBUTING.md guidelines
+<!-- Check all that apply. -->
+- [ ] I have read the [CONTRIBUTING.md](https://github.com/todogroup/awesome-ospo/blob/main/CONTRIBUTING.md) guidelines
 - [ ] I have searched for duplicate suggestions
 - [ ] The pull request has a descriptive title
 - [ ] I have added the entry to the bottom of the relevant category (if adding a new tool)
 - [ ] I have checked my spelling and grammar
 - [ ] I have removed trailing whitespace
 - [ ] I have verified that all links work correctly
-- [ ] I have provided context on why this change is needed (above)
+- [ ] I have provided context on why this change is needed above

CONTRIBUTING.md

@@ -2,60 +2,52 @@
 
 We welcome improvements and suggestions! Please consider these guidelines:
 
-## General Guidelines
+## General guidelines
 
 - Make an individual pull request for each suggestion using the provided template
-- The pull request and commit should have a useful title.
-- Search previous suggestions before making a new one, as yours may be a duplicate.
-- New links should be added to the bottom of their relevant category.
-- New categories or improvements to the existing categorization are welcome.
-- Make sure your text editor is set to remove trailing whitespace.
-- Check your spelling and grammar.
+- The pull request and commit should have a useful title
+- Search previous suggestions before making a new one, as yours may be a duplicate
+- New links should be added to the bottom of their relevant category
+- New categories or improvements to the existing categorization are welcome
+- Make sure your text editor is set to remove trailing whitespace
+- Check your spelling and grammar
 
-## Adding a New Tool or Project
+## Add a new tool or project
 
 When submitting a new tool or project, please provide context to help reviewers understand your suggestion:
 
 ### Why is this tool/project needed?
+
 - Explain the problem it solves or the gap it fills in the current list
 - Describe how it helps organizations manage open source projects or OSPOs
 - If similar tools exist in the list, explain what makes this tool unique or complementary
 
-### Choosing the Right Category
-
-Our list includes the following categories:
-- **Code Reviews** - Tools for managing and automating code review processes
-- **Continuous Integration / Continuous Delivery** - CI/CD platforms and tools
-- **Contributor License Agreements / Developer Certificate of Origins** - CLA and DCO management tools
-- **GitHub Metrics and Dashboards** - Tools for tracking and visualizing GitHub activity
-- **GitHub Management** - Tools for managing GitHub organizations and repositories
-- **Governance** - Tools for project governance and community management
-- **Project Quality** - Tools for assessing and improving project quality
-- **Supply Chain Trust** - Tools for managing software supply chain security
-- **Licensing** - Tools for managing and tracking open source licenses
-- **Localization and Internationalization** - Tools for managing translations and i18n
-- **Websites and Documentation** - Tools for creating and managing project websites and documentation
-- **Security** - Security scanning and vulnerability management tools
-- **In-Kind Donations** - Resources for in-kind donations and support programs
+### Choose the right category
 
 When adding a new tool:
-1. Review the category descriptions above
-2. Select the category that best fits the tool's primary purpose
-3. If the tool fits multiple categories, choose the one that represents its main use case
-4. In your pull request, explain why you chose that specific category
 
-### Proposing a New Category
+1. Review the category descriptions in our [README](https://github.com/todogroup/awesome-ospo/blob/main/README.md)
+1. Select the category that best fits the tool's primary purpose
+1. If the tool fits multiple categories, choose the one that represents its main use case
+1. In your pull request, explain why you chose that specific category
+
+### Propose a new category
 
 If you believe a new category is needed:
+
 1. Explain what gap the new category would fill
-2. Provide at least 2-3 examples of tools that would fit in this category
-3. Suggest where the new category should be positioned in the list
-4. Explain why existing categories are not suitable for these tools
+1. Provide at least 2-3 examples of tools that would fit in this category
+1. Suggest where the new category should be positioned in the list
+1. Explain why existing categories are not suitable for these tools
+
+## Pull request template
 
-## Pull Request Template
+When creating a pull request, please fill out the template completely.
+This helps maintainers review your contribution more efficiently and makes the review process smoother for everyone.
 
-When creating a pull request, please fill out the PR template completely. This helps maintainers review your contribution more efficiently and makes the review process smoother for everyone.
+## Maintainer review
 
-## Wait for a maintainer to review
+One of our maintainers will get back to you once they've had a chance to review the pull request.
+You can highlight the pull request in [`#project-todo-gh`](https://thetodogroup.slack.com/archives/C08AR66MQQ5) channel for a faster response.
 
-A maintainer will get back to you in the following days. You can also raise the issue in <a href="https://join.slack.com/t/thetodogroup/shared_invite/zt-2w71kclgx-JOUB4LTXIuVEKehkJk7V0w">TODO slack</a> `#project-todo-gh`channel for quick response
+(If you are not already a member of our Slack workspace, you can join via [this invite link](https://thetodogroup.slack.com/join/shared_invite/zt-2w71kclgx-JOUB4LTXIuVEKehkJk7V0w#/shared-invite/email).)

README.md

@@ -20,6 +20,8 @@ members or found helpful for managing open source projects and offices.
 
 ## Code Reviews
 
+Tools for managing and automating code review processes.
+
 - [PullApprove](https://www.pullapprove.com) - Allows for fancier rules on how pull requests are approved.
 - [sentinel](https://github.com/habitat-sh/sentinel) - PR Test, review, and merge workflow bot
 - [pull-review](https://github.com/imsky/pull-review) - assign pull request reviewers intelligently, inspired by mention-bot
@@ -28,6 +30,8 @@ members or found helpful for managing open source projects and offices.
 
 ## Continuous Integration / Continuous Delivery
 
+CI/CD platforms and tools.
+
 - [GitHub Actions](https://github.com/features/actions) - Automate your workflow from idea to production.
 - [Jenkins](https://www.jenkins.io/) - open source automation server that provides hundreds of plugins to support building, deploying and automating any project.
 - [Jenkins X](https://jenkins-x.io/) - open source CI/CD solution for modern cloud applications on Kubernetes.
@@ -39,13 +43,17 @@ members or found helpful for managing open source projects and offices.
 
 ## Contributor License Agreements / Developer Certificate of Origins
 
+CLA and DCO management tools.
+
 - [CLA Assistant](https://github.com/cla-assistant/cla-assistant) - Streamline your workflow and let CLA assistant handle the legal side of contributions to a repository for you. CLA assistant enables contributors to sign CLAs from within a pull request.
 - [Dr CLA](https://github.com/salesforce/dr-cla) - GitHub bot for dealing with Contributor License Agreements
 - [DCO Bot](https://github.com/apps/dco) - GitHub App that enforces the Developer Certificate of Origin (DCO) on Pull Requests
 - [EasyCLA](https://github.com/linuxfoundation/easycla) - a Contributor License Agreement (CLA) service used in Linux Foundation's LFX platform which lets project contributors read, sign, and submit contributor license agreements easily
 
 ## GitHub Metrics and Dashboards
 
+Tools for tracking and visualizing GitHub activity.
+
 - [osstracker](https://github.com/Netflix/osstracker) - OSS Tracker is an application that collects information about a Github organization and aggregates the data across all projects within that organization into a single user interface to be used by various roles within the owning organization.
 - [devstats](https://github.com/cncf/devstats) - A toolset to visualize GitHub archives using Grafana dashboards used by the Cloud Native Computing Foundation and Kubernetes
 - [MeasureOSS](https://github.com/MeasureOSS/Measure) - A contributor relationship management system
@@ -56,6 +64,8 @@ members or found helpful for managing open source projects and offices.
 
 ## GitHub Management
 
+Tools for managing GitHub organizations and repositories.
+
 - [opensource-management-portal](https://github.com/microsoft/opensource-management-portal) - Microsoft's Open Source Portal for GitHub is a tool to help large organizations with GitHub management operations, onboarding and more. It is implemented in Node.js.
 - [hubcommander](https://github.com/Netflix/hubcommander) - A Slack bot for GitHub organization management
 - [GitHub Settings](https://github.com/apps/settings) - uses .github/config.yml as the source of truth, and any changes to that file in the default branch will update GitHub
@@ -75,10 +85,14 @@ members or found helpful for managing open source projects and offices.
 
 ## Governance
 
+Tools for project governance and community management.
+
 - [Minimal Viable Governance](https://github.com/github/MVG) - Currently in beta - is a repository-based approach for putting lightweight governance into free and open source projects that are run in version control systems. It provides an overall two-tier organizational governance structure for a set of free and open source projects.
 
 ## Project Quality
 
+Tools for assessing and improving project quality.
+
 - [OpenSSF Best Practices Badge](https://www.bestpractices.dev/) - The Open Source Security Foundation (OpenSSF) Best Practices badge is a way for Free/Libre and Open Source Software (FLOSS) projects to show that they follow best practices. Projects can voluntarily self-certify, at no cost, by using this web application to explain how they follow each best practice. The OpenSSF Best Practices Badge is inspired by the many badges available to projects on GitHub. Consumers of the badge can quickly assess which FLOSS projects are following best practices and as a result are more likely to produce higher-quality secure software.
 - [Fosstars](https://github.com/SAP/fosstars-rating-core) - A framework for defining and calculating ratings for open source projects
 - [RepoLinter](https://github.com/todogroup/repolinter) - Lint open source repositories for common issues.
@@ -88,10 +102,14 @@ members or found helpful for managing open source projects and offices.
 
 ## Supply Chain Trust
 
+Tools/frameworks for managing software supply chain security.
+
 - [OpenChain Conformance](https://openchainproject.org) - The OpenChain Specification is a way for companies using Free/Libre and Open Source Software (FLOSS) to show that they meet the key requirements for quality compliance programs. Companies can voluntarily self-certify, at no cost, by using this web application.
 
 ## Licensing
 
+Tools for managing and tracking open source licenses.
+
 - [SPDX](https://spdx.dev/) - Set of standards for communicating the components, licenses and copyright associated with a software package.
 - [LicenseFinder](https://github.com/pivotal/LicenseFinder) - Find licenses for your project's dependencies
 - [ScanCode toolkit](https://github.com/aboutcode-org/scancode-toolkit) - Scan code for licenses, copyright and dependencies
@@ -113,22 +131,30 @@ members or found helpful for managing open source projects and offices.
 
 ## Localization and Internationalization
 
+Tools for managing translations and i18n.
+
 - [zanata](https://github.com/zanata/zanata-platform) - Zanata is a web-based system for translators to translate documentation and software online using a web browser.
 - [Weblate](https://weblate.org/) - Weblate is a free web-based translation management system.
 - [Respresso](https://respresso.io/localization-converter/) - Multiplatform localization converter for iOS (.strings + Objective-C getters), Android (strings.xml) and Web (.json).
 
 ## Websites and Documentation
 
+Tools for creating and managing project websites and documentation.
+
 - [Docusaurus](https://docusaurus.io) - Docusaurus is a React-based static site generator, specifically developed to more easily help create and maintain open source websites.
 - [GatsbyJS](https://www.gatsbyjs.com/) - Gatsby is a site generator that allows you to build fast websites and apps with React.
 - [VuePress](https://vuepress.vuejs.org/) - VuePress is a minimalistic Vue-based static site generator, optimized for writing technical documentation.
 
 ## Security
 
+Security scanning and vulnerability management tools.
+
 - [Eclipse Steady](https://github.com/eclipse-steady/steady) - Eclipse Steady, formerly known as "Vulnerability Assessement Tool" (Vulas), helps to discover, assess and mitigate known vulnerabilities in Java and Python projects.
 
 ## In-Kind Donations
 
+Resources for in-kind donations and support programs.
+
 The following organizations have formal or informal programs for offering in-kind donations to free and open source projects or foundations.
 
 - [AWS](https://aws.amazon.com/opensource/) - AWS started a program in 2019 to provide promotional credits to open source projects. Details are in [this blog post](https://aws.amazon.com/blogs/opensource/aws-promotional-credits-open-source-projects/) (Last Updated: April 14, 2021)