diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index 8eaadea..1abe1aa 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -31,6 +31,6 @@ Please provide the version number where this issue was encountered. ## Checklist - + - [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) - [ ] I have verified this does not duplicate an existing issue diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index 2af6aba..73f10e0 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -17,8 +17,8 @@ Please describe what you envision the solution to this problem would look like. ## Alternatives Considered -Please briefly describe which alternatives, if any, have been considered, including merits of alternate approaches and -tradeoffs being made. +Please briefly describe which alternatives, if any, have been considered, +including merits of alternate approaches and tradeoffs being made. ## Additional Context diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d9670b4..3853051 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,16 @@ ## Description -Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to -related issues, other PRs, or technical references. +Please provide a meaningful description of what this change will do, or is for. +Bonus points for including links to related issues, other PRs, or technical +references. -Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this -change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all. +Note that by _not_ including a description, you are asking reviewers to do extra +work to understand the context of this change, which may lead to your PR taking +much longer to review, or result in it not being reviewed at all. ## Type of Change -- [ ] Bug Fix +- [ ] Bugfix - [ ] New Feature - [ ] Breaking Change - [ ] Refactor @@ -17,7 +19,7 @@ change, which may lead to your PR taking much longer to review, or result in it ## Checklist - + - [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) - [ ] Existing issues have been referenced (where applicable) - [ ] I have verified this change is not present in other open pull requests diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 8d85f88..3cecac4 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,4 @@ +--- version: 2 updates: - package-ecosystem: "github-actions" diff --git a/.github/linters/.markdownlint.yml b/.github/linters/.markdownlint.yml new file mode 100644 index 0000000..5ac1881 --- /dev/null +++ b/.github/linters/.markdownlint.yml @@ -0,0 +1,37 @@ +--- +# Default state for all rules +default: true +# Path to configuration file to extend +extends: null + +# MD013/line-length +# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md +MD013: + # Number of characters + line_length: 80 + # Include code blocks + code_blocks: false + # Include tables + tables: false + # Include headings + headings: false + # Strict length checking + strict: false + # Stern length checking + stern: false + +# MD024/no-duplicate-heading +# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md +MD024: + # Only check sibling headings + siblings_only: true + +# MD025/single-title/single-h1 +# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md +MD025: + # RegExp for matching title in front matter + front_matter_title: "" + +# MD041/first-line-heading/first-line-h1 +# https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md +MD041: false diff --git a/.github/linters/.yamllint.yml b/.github/linters/.yamllint.yml new file mode 100644 index 0000000..e0ac2d6 --- /dev/null +++ b/.github/linters/.yamllint.yml @@ -0,0 +1,10 @@ +--- +extends: default + +rules: + line-length: + max: 80 + level: warning + indentation: disable + truthy: + check-keys: false diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index d5f5baf..70b2255 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,24 +1,38 @@ +--- name: lint on: push: + # Run superlinter on pushes to default branch branches: - # Run on pushes to default branch - main - # Run against pull requests + # Run superlinter on pull request events pull_request: +# Declare default permissions as read-only +permissions: read-all + jobs: - markdown: + super-linter: runs-on: ubuntu-latest + permissions: + contents: read + packages: read + statuses: write steps: - name: ๐Ÿ”’ harden runner - uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1 + uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1 with: egress-policy: audit - - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 - - name: โฌ‡๏ธ lint markdown files - uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0 + - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5 with: - config: ".markdownlint.json" - args: "**/*.md .github/**/*.md" + fetch-depth: 0 + - name: ๐Ÿงน run superlinter + uses: super-linter/super-linter@4758be622215d0954c8353ee4877ffd60111cf8e # v6.4.1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + LINTER_RULES_PATH: ".github/linters" + MARKDOWN_CONFIG_FILE: ".markdownlint.yml" + YAML_CONFIG_FILE: ".yamllint.yml" + VALIDATE_ALL_CODEBASE: false + MULTI_STATUS: false diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml index 532cc5c..d8ca5d7 100644 --- a/.github/workflows/scorecard.yml +++ b/.github/workflows/scorecard.yml @@ -1,3 +1,4 @@ +--- name: scorecard on: diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 152ddf8..87be5b1 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,3 +1,4 @@ +--- name: stale on: diff --git a/.markdownlint.json b/.markdownlint.json deleted file mode 100644 index 2a820e7..0000000 --- a/.markdownlint.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "default": true, - "MD013": { - "line_length": 10000, - "headings": false, - "code_blocks": false, - "tables": false - }, - "MD024": { - "siblings_only": true - }, - "MD025": { - "front_matter_title": "" - }, - "MD041": false -} diff --git a/CHANGELOG.md b/CHANGELOG.md index d93e211..6edead9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +and this project adheres to [Semantic +Versioning](https://semver.org/spec/v2.0.0.html). + + ## [Unreleased] @@ -14,9 +17,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Bump actions/checkout from 4.1.1 to 4.1.2 by @dependabot in #16 -- Bump actions/checkout from 4.1.2 to 4.1.3 in the github group by @dependabot in #17 -- Bump actions/checkout from 4.1.3 to 4.1.4 in the github group by @dependabot in #18 -- Bump actions/checkout from 4.1.4 to 4.1.5 in the github group by @dependabot in #20 +- Bump actions/checkout from 4.1.2 to 4.1.3 in the github group by @dependabot + in #17 +- Bump actions/checkout from 4.1.3 to 4.1.4 in the github group by @dependabot + in #18 +- Bump actions/checkout from 4.1.4 to 4.1.5 in the github group by @dependabot + in #20 - Bump step-security/harden-runner from 2.7.0 to 2.7.1 by @dependabot in #19 ## [1.0.0] - 2024-02-16 @@ -33,3 +39,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 [unreleased]: https://github.com/cisco-ospo/oss-template/compare/v1.0.1...HEAD [1.0.1]: https://github.com/cisco-ospo/oss-template/releases/tag/v1.0.1 [1.0.0]: https://github.com/cisco-ospo/oss-template/releases/tag/v1.0.0 + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index bffc091..37a95ff 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual identity -and orientation. +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. @@ -22,17 +22,17 @@ community include: * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community +* Focusing on what is best not just for us as individuals, but for the overall + community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or - advances of any kind +* The use of sexualized language or imagery, and sexual attention or advances of + any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission +* Publishing others' private information, such as a physical or email address, + without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting @@ -60,8 +60,8 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -. -All complaints will be reviewed and investigated promptly and fairly. +. All complaints will be reviewed and investigated +promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. @@ -82,15 +82,15 @@ behavior was inappropriate. A public apology may be requested. ### 2. Warning -**Community Impact**: A violation through a single incident or series -of actions. +**Community Impact**: A violation through a single incident or series of +actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. +like social media. Violating these terms may lead to a temporary or permanent +ban. ### 3. Temporary Ban @@ -109,8 +109,8 @@ Violating these terms may lead to a permanent ban. standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. -**Consequence**: A permanent ban from any sort of public interaction within -the community. +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution @@ -118,12 +118,12 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available -at [https://www.contributor-covenant.org/translations][translations]. +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bd83d5..794ed8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,45 +1,56 @@ # How to Contribute -Thanks for your interest in contributing to ``! Here are a few general guidelines on contributing and -reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of -the contributors managing and developing this open source project. In return, they should reciprocate that respect in -addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect, -we endeavor to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull -requests after 60 days of inactivity. - -Please note that all of your interactions in the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This -includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in -any real-time space e.g., Slack, Discord, etc. +Thanks for your interest in contributing to ``! Here are a few +general guidelines on contributing and reporting bugs that we ask you to review. +Following these guidelines helps to communicate that you respect the time of the +contributors managing and developing this open source project. In return, they +should reciprocate that respect in addressing your issue, assessing changes, and +helping you finalize your pull requests. In that spirit of mutual respect, we +endeavor to review incoming issues and pull requests within 10 days, and will +close any lingering issues or pull requests after 60 days of inactivity. + +Please note that all of your interactions in the project are subject to our +[Code of Conduct](/CODE_OF_CONDUCT.md). This includes creation of issues or pull +requests, commenting on issues or pull requests, and extends to all interactions +in any real-time space e.g., Slack, Discord, etc. ## Reporting Issues -Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our -[issues list](https://github.com/org_name/repo_name/issues). +Before reporting a new issue, please ensure that the issue was not already +reported or fixed by searching through our [issues +list](https://github.com/org_name/repo_name/issues). -When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as -possible, and, if possible, a test case. +When creating a new issue, please be sure to include a **title and clear +description**, as much relevant information as possible, and, if possible, a +test case. -**If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in -[SECURITY.md](/SECURITY.md).** +**If you discover a security bug, please do not report it through GitHub. +Instead, please see security procedures in [SECURITY.md](/SECURITY.md).** ## Sending Pull Requests -Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix -has been discussed in the past, or if the change was already implemented but not yet released. +Before sending a new pull request, take a look at existing pull requests and +issues to see if the proposed change or fix has been discussed in the past, or +if the change was already implemented but not yet released. -We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may -reserve breaking changes until the next major version release. +We expect new pull requests to include tests for any affected behavior, and, as +we follow semantic versioning, we may reserve breaking changes until the next +major version release. ## Other Ways to Contribute -We welcome anyone that wants to contribute to `` to triage and reply to open issues to help troubleshoot -and fix existing bugs. Here is what you can do: +We welcome anyone that wants to contribute to `` to triage and +reply to open issues to help troubleshoot and fix existing bugs. Here is what +you can do: -- Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, - providing feedback to the issue's author on what might be missing. -- Review and update the existing content of our [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date +- Help ensure that existing issues follows the recommendations from the + _[Reporting Issues](#reporting-issues)_ section, providing feedback to the + issue's author on what might be missing. +- Review and update the existing content of our + [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date instructions and code samples. -- Review existing pull requests, and testing patches against real existing applications that use ``. +- Review existing pull requests, and testing patches against real existing + applications that use ``. - Write a test, or add a missing test case to an existing test. Thanks again for your interest on contributing to ``! diff --git a/README.md b/README.md index 05ebacd..fbe3bfb 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,64 @@ # Open Source Project Template [![Release](https://img.shields.io/github/v/release/cisco-ospo/oss-template?display_name=tag)](CHANGELOG.md) -[![Lint](https://github.com/cisco-ospo/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/cisco-ospo/oss-template/actions/workflows/lint.yml) -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-fbab2c.svg)](CODE_OF_CONDUCT.md) +[![Lint](https://github.com/cisco-ospo/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/marketplace/actions/super-linter) +[![Contributor-Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-fbab2c.svg)](CODE_OF_CONDUCT.md) [![Maintainer](https://img.shields.io/badge/Maintainer-Cisco-00bceb.svg)](https://opensource.cisco.com) ## Before You Start -As much as possible, we have tried to provide enough tooling to get you up and running quickly and with a minimum of effort. This includes sane defaults for documentation; templates for bug reports, feature requests, and pull requests; and [GitHub Actions](https://github.com/features/actions) that will automatically manage stale issues and pull requests. This latter defaults to labeling issues and pull requests as stale after 60 days of inactivity, and closing them after 7 additional days of inactivity. These [defaults](.github/workflows/stale.yml) and more can be configured. For configuration options, please consult the documentation for the [stale action](https://github.com/actions/stale). - -In trying to keep this template as generic and reusable as possible, there are some things that were omitted out of necessity and others that need a little tweaking. Before you begin developing in earnest, there are a few changes that need to be made: - -- [ ] โœ… Select an [OSI-approved license](https://opensource.org/licenses) for your project. This can easily be achieved through the 'Add File' button on the GitHub UI, naming the file `LICENSE`, and selecting your desired license from the provided list. -- [ ] Update the `` placeholder in this file to reflect the name of the license you selected above. -- [ ] Replace `[INSERT CONTACT METHOD]` in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) with a suitable communication channel. -- [ ] Change references to `org_name` to the name of the org your repo belongs to (eg. `cisco-open`): +As much as possible, we have tried to provide enough tooling to get you up and +running quickly and with a minimum of effort. This includes sane defaults for +documentation; templates for bug reports, feature requests, and pull requests; +and [GitHub Actions](https://github.com/features/actions) that will +automatically manage stale issues and pull requests. This latter defaults to +labeling issues and pull requests as stale after 60 days of inactivity, and +closing them after 7 additional days of inactivity. These +[defaults](.github/workflows/stale.yml) and more can be configured. For +configuration options, please consult the documentation for the [stale +action](https://github.com/actions/stale). + +In trying to keep this template as generic and reusable as possible, there are +some things that were omitted out of necessity and others that need a little +tweaking. Before you begin developing in earnest, there are a few changes that +need to be made: + +- [ ] โœ… Select an [OSI-approved license](https://opensource.org/licenses) for + your project. This can easily be achieved through the 'Add File' button on the + GitHub UI, naming the file `LICENSE`, and selecting your desired license from + the provided list. +- [ ] Update the `` placeholder in this file to reflect the name + of the license you selected above. +- [ ] Replace `[INSERT CONTACT METHOD]` in + [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) with a suitable communication + channel. +- [ ] Change references to `org_name` to the name of the org your repository belongs + to (eg. `cisco-open`): - [ ] In [`README.md`](README.md) - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - [ ] Change references to `repo_name` to the name of your new repo: - [ ] In [`README.md`](README.md) - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) +- [ ] Update the Release and Lint README badges to point to your project URL. - [ ] Update the link to the contribution guidelines to point to your project: - - [ ] In [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md) - - [ ] In [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) + - [ ] In + [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md) + - [ ] In + [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) - [ ] Replace the `` placeholder with the name of your project: - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - [ ] In [`SECURITY.md`](SECURITY.md) -- [ ] Add names and contact information for actual project maintainers to [`MAINTAINERS.md`](MAINTAINERS.md). -- [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/). -- [ ] Configure [`.github/dependabot.yaml`](dependabot.yaml) for your project's language and tooling dependencies. -- [ ] Replace the generic content in this file with the relevant details about your project. -- [ ] Acknowledge that some features like [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) are only available when the repo is `public`. +- [ ] Add names and contact information for actual project maintainers to + [`MAINTAINERS.md`](MAINTAINERS.md). +- [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourage you to + [keep a changelog](https://keepachangelog.com/en/1.0.0/). +- [ ] Configure [`.github/dependabot.yaml`](dependabot.yaml) for your project's + language and tooling dependencies. +- [ ] Replace the generic content in this file with the relevant details about + your project. +- [ ] Acknowledge that some features like [branch protection + rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) + are only available when the repository is `public`. - [ ] ๐Ÿšจ Delete this section of the `README`! ## About The Project @@ -43,7 +71,8 @@ To get a local copy up and running follow these simple steps. ### Prerequisites -This is an example of how to list things you need to use the software and how to install them. +This is an example of how to list things you need to use the software and how to +install them. - npm @@ -53,13 +82,13 @@ This is an example of how to list things you need to use the software and how to ### Installation -1. Clone the repo +1. Clone the repository ```sh git clone https://github.com/org_name/repo_name.git ``` -2. Install NPM packages +2. Install npm packages ```sh npm install @@ -67,27 +96,36 @@ This is an example of how to list things you need to use the software and how to ## Usage -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. +Use this space to show useful examples of how a project can be used. Additional +screenshots, code examples and demos work well in this space. You may also link +to more resources. -_For more examples, please refer to the [Documentation](https://example.com) or the [Wiki](https://github.com/org_name/repo_name/wiki)_ +_For more examples, please refer to the [Documentation](https://example.com) or +the [Wiki](https://github.com/org_name/repo_name/wiki)_ ## Roadmap -See the [open issues](https://github.com/org_name/repo_name/issues) for a list of proposed features (and known issues). +See the [open issues](https://github.com/org_name/repo_name/issues) for a list +of proposed features (and known issues). ## Contributing -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. For detailed contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md) +Contributions are what make the open source community such an amazing place to +learn, inspire, and create. Any contributions you make are **greatly +appreciated**. For detailed contributing guidelines, please see +[CONTRIBUTING.md](CONTRIBUTING.md) ## License -Distributed under the `` License. See [LICENSE](LICENSE) for more information. +Distributed under the `` License. See [LICENSE](LICENSE) for more +information. ## Contact Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email -Project Link: [https://github.com/org_name/repo_name](https://github.com/org_name/repo_name) +Project Link: +[https://github.com/org_name/repo_name](https://github.com/org_name/repo_name) ## Acknowledgements diff --git a/SECURITY.md b/SECURITY.md index 210a9c1..c6af5c0 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -9,10 +9,10 @@ This document outlines security procedures and general policies for the ## Reporting a Bug -The `` team and community take all security bugs in -`` seriously. Thank you for improving the security of -``. We appreciate your efforts and responsible disclosure and -will make every effort to acknowledge your contributions. +The `` team and community take all security bugs in `` seriously. Thank you for improving the security of ``. We +appreciate your efforts and responsible disclosure and will make every effort to +acknowledge your contributions. Report security bugs by emailing `oss-security@cisco.com`.