From 40befdf0f8d24dce3b7d89be8739f16aaa9701c8 Mon Sep 17 00:00:00 2001 From: puneetse <22071208+puneetse@users.noreply.github.com> Date: Tue, 22 Oct 2019 11:25:47 -0700 Subject: [PATCH] Add TOC and heading formatting Add a simple table of contents for readability and revise headings to have all descending levels. --- contributing.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/contributing.md b/contributing.md index 2d9093a..c2428bd 100644 --- a/contributing.md +++ b/contributing.md @@ -4,9 +4,16 @@ Clear Linux OS is composed of many different open source software projects and welcomes all contributors to improve the project. -Before contributing, please review and abide by the [Code of Conduct](https://01.org/blogs/2018/intel-covenant-code). +Before contributing, please review and abide by the [Code of Conduct](https://01.org/blogs/2018/intel-covenant-code). Ensure any contributions align with Clear Linux philosophies on [stateless](https://clearlinux.org/features/stateless) and [security](https://docs.01.org/clearlinux/latest/guides/clear/security.html). -Ensure any contributions align with Clear Linux philosophies on [stateless](https://clearlinux.org/features/stateless) and [security](https://docs.01.org/clearlinux/latest/guides/clear/security.html). +- [Contributing software](#contributing-software) + * [Contributing to an existing software package](#contributing-to-an-existing-software-package) + * [Contributing a new software package](#contributing-a-new-software-package) + * [Contributing to Clear Linux development tooling](#contributing-to-clear-linux-development-tooling) +- [Patching source code](#patching-source-code) +- [Reporting bugs and security concerns](#reporting-bugs-and-security-concerns) + +## Contributing software ### Contributing to an existing software package @@ -98,14 +105,11 @@ See the links below for more information on how `quilt` can be used: - https://wiki.debian.org/UsingQuilt -## Reporting Bugs +## Reporting bugs and security concerns Please submit any issues in upstream packages to their respective projects. Bugs or issues related to Clear Linux Distribution may be submitted here: https://github.com/clearlinux/distribution/issues - -## Reporting Security Concerns - Visit https://01.org/security for best practices on reporting security issues.