Skip to content

Commit

Permalink
Update .github files.
Browse files Browse the repository at this point in the history
  • Loading branch information
shogo4405 committed Jan 10, 2025
1 parent 3ea44d0 commit 2be6cb9
Show file tree
Hide file tree
Showing 3 changed files with 173 additions and 15 deletions.
129 changes: 129 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Contributor Covenant Code of Conduct

## Our Pledge

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, 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
* Posting duplicate comments with the same or nearly identical content.

## 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
[email protected].
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][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
20 changes: 20 additions & 0 deletions .github/DISCUSSION_TEMPLATE/q-a.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
body:
- type: markdown
attributes:
value: |
- Feature requests and documentation requests are better suited for [Idea](https://github.com/shogo4405/HaishinKit.swift/discussions/new?category=idea).
- Frequently asked questions and answers are also here. Please take a look [FAQ](https://github.com/shogo4405/HaishinKit.swift/wiki/Frequently-Asked-Questions-and-Answers).
- type: textarea
id: questions
attributes:
label: Please describe your question
description: "Please describe your question. It would be better if you can attach some logs."
validations:
required: true
- type: markdown
attributes:
value: |
## Tips for Getting Good Answers
1. Have you set an icon for your GitHub profile? Is your profile information filled out?
1. Asking good questions leads to better answers. Refer to the following site for tips on how to ask: https://stackoverflow.com/help/how-to-ask
1. Do you absolutely need an answer? If you want personal support from the author, you need to become a contributor to HaishinKit.
39 changes: 24 additions & 15 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
name: Bug Report
description: File a bug report
description: |
Before posting, confirm whether the issue can be reproduced in the Example project(https://github.com/shogo4405/HaishinKit.swift?tab=readme-ov-file#-examples) as well.
body:
- type: markdown
attributes:
value: |
There are [standards for bug reports](https://github.com/shogo4405/HaishinKit.swift/wiki/BugReport-Standard) expected by the community. If you are posting for the first time, please read them carefully. Reports that do not meet these standards will be closed.
- type: textarea
id: observed-behavior
attributes:
label: Observed behavior
description: Explain what happened.
validations:
required: true
- type: textarea
id: describe-the-bug
id: expected-behavior
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
label: Expected behavior
description: Explain what you expect.
validations:
required: true
- type: textarea
Expand All @@ -20,18 +32,11 @@ body:
4. See error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Steps to reproduce the behavior
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: What version of our software are you running?
description: What version of our software are you running?
validations:
required: true
- type: textarea
Expand All @@ -40,13 +45,17 @@ body:
label: Smartphone info.
description: please complete the following information
placeholder: |
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Device: [e.g. iPhone 15 Pro]
- OS: [e.g. iOS 18.1]
- type: textarea
id: addditional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
description: Add any other context about the problem here. If you encounter issues while using HaishinKit for streaming or viewing, please provide the server name as well as the name of the software you are using for streaming or viewing.
placeholder: |
- Server: [e.g. nginx + rtmp module, YouTube]
- Ingest software: [e.g. OBS RTMP H264(main) AAC]
- Playback software: [e.g. iOS AVAudioPlayer(via HLS)]
- type: textarea
id: screenshot
attributes:
Expand Down

0 comments on commit 2be6cb9

Please sign in to comment.