Skip to content

Commit 32a6720

Browse files
evolvewithevanevolvewithevan
authored
Merge pull request #45 from evolvewithevan/fix/health-files
Add Project Health Files and Improve Documentation
2 parents 255acb3 + aa6492f commit 32a6720

File tree

9 files changed

+325
-3
lines changed

9 files changed

+325
-3
lines changed

‎.github/CODE_OF_CONDUCT.md‎

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

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: Also tell us, what did you expect to happen?
16+
placeholder: Tell us what you see!
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduce
22+
attributes:
23+
label: Steps to reproduce
24+
description: How can we reproduce this issue?
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '....'
28+
3. Scroll down to '....'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: dropdown
34+
id: version
35+
attributes:
36+
label: Version
37+
description: What version of GitCord are you running?
38+
options:
39+
- main (latest)
40+
- v0.1.0
41+
- Other (please specify)
42+
validations:
43+
required: true
44+
45+
- type: input
46+
id: python-version
47+
attributes:
48+
label: Python Version
49+
placeholder: e.g. 3.9.0
50+
validations:
51+
required: true
52+
53+
- type: dropdown
54+
id: os
55+
attributes:
56+
label: What operating system are you using?
57+
options:
58+
- Linux
59+
- macOS
60+
- Windows
61+
- Other
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: logs
67+
attributes:
68+
label: Relevant log output
69+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
70+
render: shell

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature!
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Is your feature request related to a problem?
15+
description: A clear and concise description of what the problem is.
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: false
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Describe the solution you'd like
24+
description: A clear and concise description of what you want to happen.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Describe alternatives you've considered
32+
description: A clear and concise description of any alternative solutions or features you've considered.
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
id: additional-context
38+
attributes:
39+
label: Additional context
40+
description: Add any other context or screenshots about the feature request here.
41+
validations:
42+
required: false
43+
44+
- type: checkboxes
45+
id: terms
46+
attributes:
47+
label: Code of Conduct
48+
description: By submitting this issue, you agree to follow our Code of Conduct
49+
options:
50+
- label: I agree to follow this project's Code of Conduct
51+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Description
2+
3+
Brief description of changes made.
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
- [ ] Refactoring (no functional changes)
12+
13+
## Testing
14+
15+
- [ ] I have tested this change locally
16+
- [ ] I have added tests that prove my fix is effective or that my feature works
17+
- [ ] New and existing unit tests pass locally with my changes
18+
19+
## Checklist
20+
21+
- [ ] My code follows the style guidelines of this project
22+
- [ ] I have performed a self-review of my own code
23+
- [ ] I have commented my code, particularly in hard-to-understand areas
24+
- [ ] I have made corresponding changes to the documentation
25+
- [ ] My changes generate no new warnings
26+
27+
## Related Issues
28+
29+
Closes #(issue)

SECURITY.md renamed to .github/SECURITY.md

File renamed without changes.

‎.github/SUPPORT.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Getting Help
2+
3+
## Documentation
4+
5+
Before asking for help, please check our documentation:
6+
7+
- [README](../README.md) - Basic setup and usage
8+
- [Wiki Documentation](https://github.com/evolvewithevan/gitcord/wiki)
9+
- [API Reference](../docs/src/api-reference/)
10+
11+
## Community Support
12+
13+
### GitHub Issues
14+
15+
For bugs, feature requests, or questions about the project:
16+
- [Open an issue](https://github.com/evolvewithevan/gitcord/issues/new)
17+
- Search existing issues first to avoid duplicates
18+
19+
### GitHub Discussions
20+
21+
For general questions, ideas, or community discussion:
22+
- [Start a discussion](https://github.com/evolvewithevan/gitcord/discussions)
23+
24+
## Contact
25+
26+
### Project Maintainer
27+
- **Email**: [email protected]
28+
- **GitHub**: [@evolvewithevan](https://github.com/evolvewithevan)
29+
30+
## Response Times
31+
32+
- **Issues**: We aim to respond within 48 hours
33+
- **Pull Requests**: We aim to review within 72 hours
34+
- **Security Issues**: We aim to respond within 24 hours
35+
36+
## Before You Ask
37+
38+
Please include:
39+
- GitCord version
40+
- Python version
41+
- Operating system
42+
- Steps to reproduce (for bugs)
43+
- Expected vs actual behavior
44+
- Relevant logs or error messages

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ gitcord/
144144
145145
## 🤝 Contributing
146146
147-
We welcome contributions! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for:
147+
We welcome contributions! Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for:
148148
- Coding standards (PEP8, type hints, docstrings)
149149
- How to set up your dev environment
150150
- Testing and documentation guidelines

‎src/gitcord/cogs/help.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ async def help_prefix(self, ctx: commands.Context) -> None:
6767
"• [Github Project](https://github.com/users/evolvewithevan/projects/4/views/1)\n"
6868
"• [Roadmap](https://github.com/users/evolvewithevan/projects/4/views/3)\n"
6969
"• [Wiki Documentation](https://github.com/evolvewithevan/gitcord/wiki)\n"
70-
"• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/SECURITY.md)",
70+
"• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/.github/SECURITY.md)",
7171
inline=False,
7272
)
7373

@@ -125,7 +125,7 @@ async def help_slash(self, interaction: discord.Interaction) -> None:
125125
"• [Github Project](https://github.com/users/evolvewithevan/projects/4/views/1)\n"
126126
"• [Roadmap](https://github.com/users/evolvewithevan/projects/4/views/3)\n"
127127
"• [Wiki Documentation](https://github.com/evolvewithevan/gitcord/wiki)\n"
128-
"• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/SECURITY.md)",
128+
"• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/.github/SECURITY.md)",
129129
inline=False,
130130
)
131131

0 commit comments

Comments
 (0)