Skip to content

Commit

Permalink
fix(markdown): adds styling fixes to Markdown files
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Oct 3, 2024
1 parent 11e271c commit 92d0713
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 24 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of Conduct

We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ cannot be accepted at all!**

We have also adopted [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).

### Merge details for committers:
### Merge details for committers

1. All merges into develop MUST be conducted by a squash-merge
1. All merges from develop into main MUST be done by a merge commit (e.g. preserving the history of commits into the develop branch).
Expand Down Expand Up @@ -84,7 +84,7 @@ e.g.

### Developer's Certificate of Origin

We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution.
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution.

We use the [Developer's Certificate of Origin 1.1 (DCO)](https://developercertificate.org/) to manage code contributions (the same approach as the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin))

Expand All @@ -108,4 +108,4 @@ local git repository using the following command:

```bash
git commit --signoff
```
```
8 changes: 4 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ The following document outlines how the OSCAL Compass project governance operate

The OSCAL Compass community adheres to the following principles:

**Open**: OSCAL-Compass is open source. See project guidelines [here](./CONTRIBUTING.md).
**Welcoming and respectful**: See [Code of Conduct](./CODE_OF_CONDUCT.md).
**Transparent and accessible**: Work and collaboration should be done in public.
**Merit**: Ideas and contributions are accepted according to their technical merit and alignment with project objectives, scope, and design principles. See our design proposal [process](./proposals/README.md)
**Open**: OSCAL-Compass is open source. See project guidelines [here](./CONTRIBUTING.md).
**Welcoming and respectful**: See [Code of Conduct](./CODE_OF_CONDUCT.md).
**Transparent and accessible**: Work and collaboration should be done in public.
**Merit**: Ideas and contributions are accepted according to their technical merit and alignment with project objectives, scope, and design principles. See our design proposal [process](./proposals/README.md)

## Governance Structure Overview

Expand Down
2 changes: 1 addition & 1 deletion MEMBERSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ Changes to contributor roles must be approved by a vote of the Oversight Committ

## Acknowledgements

Contributor roles and responsibilities were adapted from InstructLab [contributor roles](https://raw.githubusercontent.com/instructlab/community/main/CONTRIBUTOR_ROLES.md)
Contributor roles and responsibilities were adapted from InstructLab [contributor roles](https://raw.githubusercontent.com/instructlab/community/main/CONTRIBUTOR_ROLES.md)
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Contributing new features, resolving bugs and issues, and refining the documenta

The goals of this open source community includes the following:

* Drive adoption of the OSCAL standard using Trestle, Agile Authoring, and C2P tools for end-to-end compliance automation.
* Come up with use-cases for automating compliance processes in an organization and the required tooling support.
* Influence the OSCAL standard based on the requirements and use-cases identified.
- Drive adoption of the OSCAL standard using Trestle, Agile Authoring, and C2P tools for end-to-end compliance automation.
- Come up with use-cases for automating compliance processes in an organization and the required tooling support.
- Influence the OSCAL standard based on the requirements and use-cases identified.


## Learn about the projects
Expand All @@ -41,7 +41,7 @@ Compliance-to-Policy (C2P) bridges Compliance as Code and Policy as Code. C2P ta

## Community meetings and communications

##### Scheduled meetings
### Scheduled meetings

Please attend! All are invited.

Expand All @@ -64,13 +64,12 @@ We also have a [shared calendar](https://calendar.google.com/calendar/u/0?cid=Nj

All of our meeting recordings are available for review on our YouTube [channel](https://www.youtube.com/@OSCAL-Compass).

##### Email
### Email

Google Group: [oscal-compass](https://groups.google.com/g/oscal-compass)\
[email protected]


##### Chat anytime
### Chat anytime

Slack: [#oscal-compliance-trestle-agileauthoring-c2p](https://cloud-native.slack.com/archives/C06F3PEPNBW)

Expand Down Expand Up @@ -114,4 +113,3 @@ We are a Cloud Native Computing Foundation sandbox project.
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage)".

*OSCAL Compass was originally contributed by IBM.*

3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ and mentioned in the fixed versions' release notes.
## Supported Versions

All OSCAL Compass projects follow [Semantic Versioning](https://semver.org/) terminology and are expressed as x.y.z:

- where x is the major version
- y is the minor version
- and z is the patch version
Expand All @@ -45,4 +46,4 @@ Security fixes are typically addressed in the main branch and may be backported

## Acknowledgments

Parts of this policy were adapted from the Crossplane [security policy](https://github.com/crossplane/crossplane/blob/master/SECURITY.md)
Parts of this policy were adapted from the Crossplane [security policy](https://github.com/crossplane/crossplane/blob/master/SECURITY.md)
4 changes: 2 additions & 2 deletions presentations/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Introduction
# Introduction

Welcome to the reusable presentation materials for OSCAL Compass! These materials are designed to be easily customized and adapted by anyone in the community who wants to present on the project.

Expand All @@ -21,4 +21,4 @@ These materials are licensed under the Apache 2.0 License - see the [LICENSE](ht

## Feedback

If you have any questions or would like to provide feedback on these materials, please open a GitHub Issue on this repository.
If you have any questions or would like to provide feedback on these materials, please open a GitHub Issue on this repository.
8 changes: 4 additions & 4 deletions proposals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document outlines the how to propose large scale or architectural project c

> Note: This is a draft process
# When to use this process
## When to use this process

On many occasions, ideas for new functionality or upgrades can be brought forth in a GitHub issue or discussion concerning the project. These suggestions are publicly discussed among maintainers, contributors, users, and other concerned stakeholders. Once an agreement is reached among participants, the proposed alterations move through the pull request process, during which the implementation specifics are examined, approved, or rejected by maintainers.

Expand All @@ -24,17 +24,17 @@ Examples of changes to handle on the project level:
* Fixing a flaky test
* Code Refactoring

# How to engage in the process
## How to engage in the process

## Prerequisites
### Prerequisites

Complete the following steps before creating a change proposal:

* Circulate your idea within the community to see if there is interest
* Optionally, create a prototype in your own fork
* If a new project or codebase is proposed, identify project maintainers

## Process
### Process

* Create an instance of the template using `trestle author docs create-sample -tn proposals`.
* Submit a change proposal under `proposals` by opening a pull request.
Expand Down

0 comments on commit 92d0713

Please sign in to comment.