diff options
Diffstat (limited to 'vendor/github.com/lrstanley/girc')
-rw-r--r-- | vendor/github.com/lrstanley/girc/CODE_OF_CONDUCT.md | 122 | ||||
-rw-r--r-- | vendor/github.com/lrstanley/girc/CONTRIBUTING.md | 106 | ||||
-rw-r--r-- | vendor/github.com/lrstanley/girc/README.md | 46 | ||||
-rw-r--r-- | vendor/github.com/lrstanley/girc/SECURITY.md | 54 | ||||
-rw-r--r-- | vendor/github.com/lrstanley/girc/SUPPORT.md | 56 |
5 files changed, 28 insertions, 356 deletions
diff --git a/vendor/github.com/lrstanley/girc/CODE_OF_CONDUCT.md b/vendor/github.com/lrstanley/girc/CODE_OF_CONDUCT.md deleted file mode 100644 index 0eb65874..00000000 --- a/vendor/github.com/lrstanley/girc/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,122 +0,0 @@ -<!-- THIS FILE IS GENERATED! DO NOT EDIT! Maintained by Terraform. --> -# Code of Conduct - -## Our Pledge :purple_heart: - -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. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* 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 - -Examples of unacceptable behavior include: - -* 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 -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -disclosure@liamstanley.io. 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. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**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. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -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. - -## Attribution - -This Code of Conduct is adapted from the Contributor Covenant, -version 2.1, available [here](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). - -For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq). -Translations are available at [translations](https://www.contributor-covenant.org/translations). diff --git a/vendor/github.com/lrstanley/girc/CONTRIBUTING.md b/vendor/github.com/lrstanley/girc/CONTRIBUTING.md deleted file mode 100644 index 9c237e3c..00000000 --- a/vendor/github.com/lrstanley/girc/CONTRIBUTING.md +++ /dev/null @@ -1,106 +0,0 @@ -<!-- THIS FILE IS GENERATED! DO NOT EDIT! Maintained by Terraform. --> -# :handshake: Contributing - -This document outlines some of the guidelines that we try and adhere to while -working on this project. - -> :point_right: **Note**: before participating in the community, please read our -> [Code of Conduct][coc]. -> By interacting with this repository, organization, or community you agree to -> abide by our Code of Conduct. -> -> Additionally, if you contribute **any source code** to this repository, you -> agree to the terms of the [Developer Certificate of Origin][dco]. This helps -> ensure that contributions aren't in violation of 3rd party license terms. - -## :lady_beetle: Issue submission - -When [submitting an issue][issues] or bug report, -please follow these guidelines: - - * Provide as much information as possible (logs, metrics, screenshots, - runtime environment, etc). - * Ensure that you are running on the latest stable version (tagged), or - when using `master`, provide the specific commit being used. - * Provide the minimum needed viable source to replicate the problem. - -## :bulb: Feature requests - -When [submitting a feature request][issues], please -follow these guidelines: - - * Does this feature benefit others? or just your usecase? If the latter, - it will likely be declined, unless it has a more broad benefit to others. - * Please include the pros and cons of the feature. - * If possible, describe how the feature would work, and any diagrams/mock - examples of what the feature would look like. - -## :rocket: Pull requests - -To review what is currently being worked on, or looked into, feel free to head -over to the [open pull requests][pull-requests] or [issues list][issues]. - -## :raised_back_of_hand: Assistance with discussions - - * Take a look at the [open discussions][discussions], and if you feel like - you'd like to help out other members of the community, it would be much - appreciated! - -## :pushpin: Guidelines - -### :test_tube: Language agnostic - -Below are a few guidelines if you would like to contribute: - - * If the feature is large or the bugfix has potential breaking changes, - please open an issue first to ensure the changes go down the best path. - * If possible, break the changes into smaller PRs. Pull requests should be - focused on a specific feature/fix. - * Pull requests will only be accepted with sufficient documentation - describing the new functionality/fixes. - * Keep the code simple where possible. Code that is smaller/more compact - does not mean better. Don't do magic behind the scenes. - * Use the same formatting/styling/structure as existing code. - * Follow idioms and community-best-practices of the related language, - unless the previous above guidelines override what the community - recommends. - * Always test your changes, both the features/fixes being implemented, but - also in the standard way that a user would use the project (not just - your configuration that fixes your issue). - * Only use 3rd party libraries when necessary. If only a small portion of - the library is needed, simply rewrite it within the library to prevent - useless imports. - -### :hamster: Golang - - * See [golang/go/wiki/CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) - * This project uses [golangci-lint](https://golangci-lint.run/) for - Go-related files. This should be available for any editor that supports - `gopls`, however you can also run it locally with `golangci-lint run` - after installing it. - - - - -## :clipboard: References - - * [Open Source: How to Contribute](https://opensource.guide/how-to-contribute/) - * [About pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) - * [GitHub Docs](https://docs.github.com/) - -## :speech_balloon: What to do next? - - * :old_key: Find a vulnerability? Check out our [Security and Disclosure][security] policy. - * :link: Repository [License][license]. - * [Support][support] - * [Code of Conduct][coc]. - -<!-- definitions --> -[coc]: https://github.com/lrstanley/girc/blob/master/CODE_OF_CONDUCT.md -[dco]: https://developercertificate.org/ -[discussions]: https://github.com/lrstanley/girc/discussions -[issues]: https://github.com/lrstanley/girc/issues/new/choose -[license]: https://github.com/lrstanley/girc/blob/master/LICENSE -[pull-requests]: https://github.com/lrstanley/girc/issues/new/choose -[security]: https://github.com/lrstanley/girc/security/policy -[support]: https://github.com/lrstanley/girc/blob/master/SUPPORT.md diff --git a/vendor/github.com/lrstanley/girc/README.md b/vendor/github.com/lrstanley/girc/README.md index 0a5fba99..9f62ca85 100644 --- a/vendor/github.com/lrstanley/girc/README.md +++ b/vendor/github.com/lrstanley/girc/README.md @@ -3,32 +3,42 @@ <!-- do not edit anything in this "template" block, its auto-generated --> <p align="center">girc -- :bomb: girc is a flexible IRC library for Go :ok_hand:</p> <p align="center"> + <a href="https://github.com/lrstanley/girc/tags"> + <img title="Latest Semver Tag" src="https://img.shields.io/github/v/tag/lrstanley/girc?style=flat-square"> + </a> + <a href="https://github.com/lrstanley/girc/commits/master"> + <img title="Last commit" src="https://img.shields.io/github/last-commit/lrstanley/girc?style=flat-square"> + </a> <a href="https://github.com/lrstanley/girc/actions?query=workflow%3Atest+event%3Apush"> - <img alt="GitHub Workflow Status (test @ master)" src="https://img.shields.io/github/workflow/status/lrstanley/girc/test/master?label=test&style=flat-square&event=push"> + <img title="GitHub Workflow Status (test @ master)" src="https://img.shields.io/github/workflow/status/lrstanley/girc/test/master?label=test&style=flat-square&event=push"> </a> - <img alt="Code Coverage" src="https://img.shields.io/codecov/c/github/lrstanley/girc/master?style=flat-square"> + <a href="https://codecov.io/gh/lrstanley/girc"> + <img title="Code Coverage" src="https://img.shields.io/codecov/c/github/lrstanley/girc/master?style=flat-square"> + </a> <a href="https://pkg.go.dev/github.com/lrstanley/girc"> - <img alt="Go Documentation" src="https://pkg.go.dev/badge/github.com/lrstanley/girc?style=flat-square"> + <img title="Go Documentation" src="https://pkg.go.dev/badge/github.com/lrstanley/girc?style=flat-square"> </a> <a href="https://goreportcard.com/report/github.com/lrstanley/girc"> - <img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/lrstanley/girc?style=flat-square"> + <img title="Go Report Card" src="https://goreportcard.com/badge/github.com/lrstanley/girc?style=flat-square"> </a> - <img alt="Bug reports" src="https://img.shields.io/github/issues/lrstanley/girc/bug?label=issues&style=flat-square"> - <img alt="Feature requests" src="https://img.shields.io/github/issues/lrstanley/girc/enhancement?label=feature%20requests&style=flat-square"> - <a href="https://github.com/lrstanley/girc/pulls"> - <img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/lrstanley/girc?style=flat-square"> +</p> +<p align="center"> + <a href="https://github.com/lrstanley/girc/issues?q=is:open+is:issue+label:bug"> + <img title="Bug reports" src="https://img.shields.io/github/issues/lrstanley/girc/bug?label=issues&style=flat-square"> </a> - <a href="https://github.com/lrstanley/girc/tags"> - <img alt="Latest Semver Tag" src="https://img.shields.io/github/v/tag/lrstanley/girc?style=flat-square"> + <a href="https://github.com/lrstanley/girc/issues?q=is:open+is:issue+label:enhancement"> + <img title="Feature requests" src="https://img.shields.io/github/issues/lrstanley/girc/enhancement?label=feature%20requests&style=flat-square"> + </a> + <a href="https://github.com/lrstanley/girc/pulls"> + <img title="Open Pull Requests" src="https://img.shields.io/github/issues-pr/lrstanley/girc?label=prs&style=flat-square"> </a> - <img alt="Last commit" src="https://img.shields.io/github/last-commit/lrstanley/girc?style=flat-square"> <a href="https://github.com/lrstanley/girc/discussions/new?category=q-a"> - <img alt="Ask a Question" src="https://img.shields.io/badge/discussions-ask_a_question!-green?style=flat-square"> + <img title="Ask a Question" src="https://img.shields.io/badge/support-ask_a_question!-blue?style=flat-square"> </a> - <a href="https://liam.sh/chat"><img src="https://img.shields.io/badge/discord-bytecord-blue.svg?style=flat-square" alt="Discord Chat"></a> + <a href="https://liam.sh/chat"><img src="https://img.shields.io/badge/discord-bytecord-blue.svg?style=flat-square" title="Discord Chat"></a> </p> <!-- template:end:header --> @@ -40,7 +50,7 @@ - [Installing](#installing) - [Examples](#examples) - [References](#references) - - [Support & Assistance](#raising_hand_man-support-assistance) + - [Support & Assistance](#raising_hand_man-support--assistance) - [Contributing](#handshake-contributing) - [License](#balance_scale-license) <!-- template:end:toc --> @@ -107,10 +117,10 @@ Working on a project and want to add it to the list? Submit a pull request! <!-- do not edit anything in this "template" block, its auto-generated --> ## :raising_hand_man: Support & Assistance - * :heart: Please review the [Code of Conduct](CODE_OF_CONDUCT.md) for + * :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines on ensuring everyone has the best experience interacting with the community. - * :raising_hand_man: Take a look at the [support](SUPPORT.md) document on + * :raising_hand_man: Take a look at the [support](.github/SUPPORT.md) document on guidelines for tips on how to ask the right questions. * :lady_beetle: For all features/bugs/issues/questions/etc, [head over here](https://github.com/lrstanley/girc/issues/new/choose). <!-- template:end:support --> @@ -119,10 +129,10 @@ Working on a project and want to add it to the list? Submit a pull request! <!-- do not edit anything in this "template" block, its auto-generated --> ## :handshake: Contributing - * :heart: Please review the [Code of Conduct](CODE_OF_CONDUCT.md) for guidelines + * :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines on ensuring everyone has the best experience interacting with the community. - * :clipboard: Please review the [contributing](CONTRIBUTING.md) doc for submitting + * :clipboard: Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting issues/a guide on submitting pull requests and helping out. * :old_key: For anything security related, please review this repositories [security policy](https://github.com/lrstanley/girc/security/policy). <!-- template:end:contributing --> diff --git a/vendor/github.com/lrstanley/girc/SECURITY.md b/vendor/github.com/lrstanley/girc/SECURITY.md deleted file mode 100644 index 7c951d0c..00000000 --- a/vendor/github.com/lrstanley/girc/SECURITY.md +++ /dev/null @@ -1,54 +0,0 @@ -<!-- THIS FILE IS GENERATED! DO NOT EDIT! Maintained by Terraform. --> -# :old_key: Security Policy - -## :heavy_check_mark: Supported Versions - -The following restrictions apply for versions that are still supported in terms of security and bug fixes: - - * :grey_question: Must be using the latest major/minor version. - * :grey_question: Must be using a supported platform for the repository (e.g. OS, browser, etc), and that platform must - be within its supported versions (for example: don't use a legacy or unsupported version of Ubuntu or - Google Chrome). - * :grey_question: Repository must not be archived (unless the vulnerability is critical, and the repository moderately - popular). - * :heavy_check_mark: - -If one of the above doesn't apply to you, feel free to submit an issue and we can discuss the -issue/vulnerability further. - - -## :lady_beetle: Reporting a Vulnerability - -Best method of contact: [GPG :key:](https://github.com/lrstanley.gpg) - - * :speech_balloon: [Discord][chat]: message `/home/liam#0000`. - * :email: Email: `security@liamstanley.io` - -Backup contacts (if I am unresponsive after **48h**): [GPG :key:](https://github.com/FM1337.gpg) - * :speech_balloon: [Discord][chat]: message `Allen#7440`. - * :email: Email: `security@allenlydiard.ca` - -If you feel that this disclosure doesn't include a critical vulnerability and there is no sensitive -information in the disclosure, you don't have to use the GPG key. For all other situations, please -use it. - -### :stopwatch: Vulnerability disclosure expectations - - * :no_bell: We expect you to not share this information with others, unless: - * The maximum timeline for initial response has been exceeded (shown below). - * The maximum resolution time has been exceeded (shown below). - * :mag_right: We expect you to responsibly investigate this vulnerability -- please do not utilize the - vulnerability beyond the initial findings. - * :stopwatch: Initial response within 48h, however, if the primary contact shown above is unavailable, please - use the backup contacts provided. The maximum timeline for an initial response should be within - 7 days. - * :stopwatch: Depending on the severity of the disclosure, resolution time may be anywhere from 24h to 2 - weeks after initial response, though in most cases it will likely be closer to the former. - * If the vulnerability is very low/low in terms of risk, the above timelines **will not apply**. - * :toolbox: Before the release of resolved versions, a [GitHub Security Advisory][advisory-docs]. - will be released on the respective repository. [Browser all advisories here][advisory]. - -<!-- definitions --> -[chat]: https://liam.sh/chat -[advisory]: https://github.com/advisories?query=type%3Areviewed+ecosystem%3Ago -[advisory-docs]: https://docs.github.com/en/code-security/repository-security-advisories/creating-a-repository-security-advisory diff --git a/vendor/github.com/lrstanley/girc/SUPPORT.md b/vendor/github.com/lrstanley/girc/SUPPORT.md deleted file mode 100644 index aca24782..00000000 --- a/vendor/github.com/lrstanley/girc/SUPPORT.md +++ /dev/null @@ -1,56 +0,0 @@ -# :raising_hand_man: Support - -This document explains where and how to get help with most of my projects. -Please ensure you read through it thoroughly. - -> :point_right: **Note**: before participating in the community, please read our -> [Code of Conduct][coc]. -> By interacting with this repository, organization, or community you agree to -> abide by its terms. - -## :grey_question: Asking quality questions - -Questions can go to [Github Discussions][discussions] or feel free to join -the Discord [here][chat]. - -Help me help you! Spend time framing questions and add links and resources. -Spending the extra time up front can help save everyone time in the long run. -Here are some tips: - -* Don't fall for the [XY problem][xy]. -* Search to find out if a similar question has been asked or if a similar - issue/bug has been reported. -* Try to define what you need help with: - * Is there something in particular you want to do? - * What problem are you encountering and what steps have you taken to try - and fix it? - * Is there a concept you don't understand? -* Provide sample code, such as a [CodeSandbox][cs] or a simple snippet, if - possible. -* Screenshots can help, but if there's important text such as code or error - messages in them, please also provide those. -* The more time you put into asking your question, the better I and others - can help you. - -## :old_key: Security - -For any security or vulnerability related disclosure, please follow the -guidelines outlined in our [security policy][security]. - -## :handshake: Contributions - -See [`CONTRIBUTING.md`][contributing] on how to contribute. - -<!-- definitions --> -[coc]: https://github.com/lrstanley/girc/blob/master/CODE_OF_CONDUCT.md -[contributing]: https://github.com/lrstanley/girc/blob/master/CONTRIBUTING.md -[discussions]: https://github.com/lrstanley/girc/discussions/categories/q-a -[issues]: https://github.com/lrstanley/girc/issues/new/choose -[license]: https://github.com/lrstanley/girc/blob/master/LICENSE -[pull-requests]: https://github.com/lrstanley/girc/issues/new/choose -[security]: https://github.com/lrstanley/girc/security/policy -[support]: https://github.com/lrstanley/girc/blob/master/SUPPORT.md - -[xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378 -[chat]: https://liam.sh/chat -[cs]: https://codesandbox.io |