Skip to content

Commit ebe4e1b

Browse files
committed
Add repository governance and community templates
Add funding, issue templates, PR template, contributing, support, security, code of conduct, and license documents for the repository.
1 parent f1a15cd commit ebe4e1b

10 files changed

Lines changed: 941 additions & 0 deletions

File tree

.github/FUNDING.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Funding platforms
2+
# Update these entries with your handles if you use them.
3+
github: []
4+
patreon: AndroidIRCx
5+
ko_fi: majstorov
6+
custom:
7+
- https://paypal.me/majstorov
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Bug Report
2+
description: Report a bug in AndroidIRCX
3+
title: "[Bug]: "
4+
labels: [ "bug" ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Thanks for taking the time to report a bug. Please fill out the info below."
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: What happened?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: steps
18+
attributes:
19+
label: Steps to Reproduce
20+
description: Provide clear steps to reproduce the issue.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: expected
25+
attributes:
26+
label: Expected Behavior
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: actual
31+
attributes:
32+
label: Actual Behavior
33+
validations:
34+
required: true
35+
- type: input
36+
id: version
37+
attributes:
38+
label: App Version
39+
placeholder: e.g. 1.7.0
40+
- type: input
41+
id: device
42+
attributes:
43+
label: Device/OS
44+
placeholder: e.g. Pixel 7 / Android 14
45+
- type: textarea
46+
id: logs
47+
attributes:
48+
label: Logs or Screenshots
49+
description: Paste logs or attach screenshots.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions and Discussion
4+
url: https://github.com/androidircx/androidircx/discussions
5+
about: Ask questions and start discussions.
6+
- name: Security Reports
7+
url: https://github.com/androidircx/androidircx/security/advisories/new
8+
about: Report security vulnerabilities privately.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature Request
2+
description: Suggest an idea for AndroidIRCX
3+
title: "[Feature]: "
4+
labels: [ "enhancement" ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "Thanks for the suggestion. Please describe the feature and its value."
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: Problem
13+
description: What problem are you trying to solve?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: solution
18+
attributes:
19+
label: Proposed Solution
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Alternatives Considered
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Additional Context
32+
validations:
33+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Pull Request
2+
3+
## Summary
4+
5+
- Describe the change
6+
- Reference any related issues
7+
8+
## Checklist
9+
10+
- [ ] Tests added or updated (if applicable)
11+
- [ ] Documentation updated (if applicable)
12+
- [ ] UI changes include screenshots (if applicable)

CODE_OF_CONDUCT.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at:
63+
contact@androidircx.com
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
1. Correction
75+
76+
Community Impact: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
Consequence: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
2. Warning
84+
85+
Community Impact: A violation through a single incident or series of
86+
actions.
87+
88+
Consequence: A warning with consequences for continued behavior. No interaction
89+
with the people involved, including unsolicited interaction with those
90+
enforcing the Code of Conduct, for a specified period of time. This includes
91+
avoiding interactions in community spaces as well as external channels like
92+
social media. Violating these terms may lead to a temporary or permanent ban.
93+
94+
3. Temporary Ban
95+
96+
Community Impact: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
Consequence: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
4. Permanent Ban
106+
107+
Community Impact: Demonstrating a pattern of violation of community standards,
108+
including sustained inappropriate behavior, harassment of an individual, or
109+
aggression toward or disparagement of classes of individuals.
110+
111+
Consequence: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1,
117+
available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
118+
119+
Community Impact Guidelines were inspired by Mozilla's code of conduct
120+
enforcement ladder.

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to AndroidIRCX.
4+
5+
## Ways to Contribute
6+
7+
- Report bugs and request features via GitHub Issues.
8+
- Improve documentation.
9+
- Submit code changes through pull requests.
10+
11+
## Development Workflow
12+
13+
1. Fork the repo and create a feature branch.
14+
2. Make your changes with clear, focused commits.
15+
3. Run relevant tests for the areas you touched.
16+
4. Open a pull request with a clear description and screenshots if UI changes are involved.
17+
18+
## Code Style
19+
20+
- Use TypeScript for new code.
21+
- Prefer small, focused services and components.
22+
- Keep changes scoped and avoid unrelated refactors.
23+
24+
## Reporting Bugs
25+
26+
Please include:
27+
28+
- Steps to reproduce
29+
- Expected vs actual behavior
30+
- Device/OS and app version
31+
- Logs or screenshots when possible
32+
33+
## License
34+
35+
By contributing, you agree that your contributions will be licensed under the GPL-3.0.

0 commit comments

Comments
 (0)