Skip to content

Commit 48e6489

Browse files
committed
docs: add community health files
Signed-off-by: FenjuFu <fufenjupku@gmail.com>
1 parent 13a5ae4 commit 48e6489

5 files changed

Lines changed: 163 additions & 0 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# iFLYTEK Open Source Community Code of Conduct
2+
3+
As contributors, maintainers, and participants in the iFLYTEK Open Source
4+
Community, we pledge to make participation in this project a harassment-free
5+
experience for everyone.
6+
7+
## Our standards
8+
9+
Examples of behavior that contributes to a positive community include:
10+
11+
- Demonstrating empathy and kindness toward other people
12+
- Respecting differing opinions, viewpoints, and experiences
13+
- Giving and gracefully accepting constructive feedback
14+
- Accepting responsibility, apologizing, and learning from mistakes
15+
- Focusing on what is best for the overall community
16+
- Using welcoming and inclusive language
17+
18+
Examples of unacceptable behavior include:
19+
20+
- Sexualized language or imagery and unwelcome sexual attention
21+
- Trolling, insulting or derogatory comments, and personal or political attacks
22+
- Public or private harassment
23+
- Publishing another person's private information without explicit permission
24+
- Violence, threats of violence, stalking, or unwelcome physical contact
25+
- Knowingly providing false information during an investigation
26+
- Retaliating against someone who reports an incident or acts as a witness
27+
28+
Project maintainers may remove, edit, or reject contributions that do not align
29+
with this Code of Conduct and will apply these standards fairly and consistently.
30+
31+
## Scope
32+
33+
This Code of Conduct applies in all project and community spaces. It also applies
34+
when an individual represents the project or directs words or actions at a
35+
community participant in the context of a project activity.
36+
37+
## Reporting and enforcement
38+
39+
Report incidents privately to the
40+
[iFLYTEK Open Source Code of Conduct Committee](https://github.com/iflytek/community/tree/master/code-of-conduct).
41+
If a private contact channel is unavailable, use the
42+
[iFLYTEK community issue tracker](https://github.com/iflytek/community/issues/new)
43+
and avoid including sensitive personal information in a public report.
44+
45+
The response team will review reports and determine appropriate action. Retaliation
46+
against reporters or witnesses is prohibited.
47+
48+
## Attribution
49+
50+
This project follows the
51+
[iFLYTEK Open Source Community Code of Conduct](https://github.com/iflytek/community/blob/master/code-of-conduct.md),
52+
which is adapted from the Contributor Covenant, version 2.0.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Bug report
2+
description: Report a reproducible problem in Domux
3+
title: "[Bug]: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thanks for helping us improve Domux. Please search existing issues first.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Problem
13+
description: What happened, and what did you expect instead?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: reproduction
18+
attributes:
19+
label: Steps to reproduce
20+
description: Include the smallest reproducible input, command, or code sample.
21+
validations:
22+
required: true
23+
- type: input
24+
id: version
25+
attributes:
26+
label: Domux version or commit
27+
placeholder: v0.1.0 or commit SHA
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: environment
32+
attributes:
33+
label: Environment
34+
description: Operating system, Python version, hardware, and relevant dependencies.
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: logs
39+
attributes:
40+
label: Logs and additional context
41+
description: Remove credentials and sensitive information before posting.
42+
render: shell

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability
4+
url: https://github.com/iflytek/community/blob/master/SECURITY.md
5+
about: Follow the private reporting process instead of opening a public issue.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature request
2+
description: Propose an improvement to Domux
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Please describe the user problem before proposing a solution.
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: User problem
13+
description: What use case is difficult or impossible today?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: proposal
18+
attributes:
19+
label: Proposed solution
20+
description: Describe the behavior and, if useful, a possible API or workflow.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Alternatives considered
27+
description: How are you handling this today?
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Additional context
32+
description: Add examples, mockups, benchmarks, or related links.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Question
2+
description: Ask for help using or understanding Domux
3+
title: "[Question]: "
4+
labels: [question]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Please check the README, documentation, and existing issues first.
9+
- type: textarea
10+
id: question
11+
attributes:
12+
label: Question
13+
description: What are you trying to accomplish, and where are you blocked?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: attempted
18+
attributes:
19+
label: What have you tried?
20+
description: Include relevant commands, configuration, or documentation.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: environment
25+
attributes:
26+
label: Environment
27+
description: Domux version, operating system, Python version, and relevant dependencies.
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Additional context
32+
description: Remove credentials and sensitive information before posting logs.

0 commit comments

Comments
 (0)