diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a218ef5 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ + +# 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, 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 email 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 evolvewithevan@gmail.com. +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](https://www.contributor-covenant.org/), version 2.1, +available at +. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion). + +For answers to common questions about this code of conduct, see the FAQ at +. Translations are available at +. + diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..dd26d47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,70 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: How can we reproduce this issue? + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: dropdown + id: version + attributes: + label: Version + description: What version of GitCord are you running? + options: + - main (latest) + - v0.1.0 + - Other (please specify) + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python Version + placeholder: e.g. 3.9.0 + validations: + required: true + + - type: dropdown + id: os + attributes: + label: What operating system are you using? + options: + - Linux + - macOS + - Windows + - Other + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..af3e02b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,51 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["enhancement", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! + + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when... + validations: + required: false + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our Code of Conduct + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..80fd852 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ +## Description + +Brief description of changes made. + +## Type of Change + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Refactoring (no functional changes) + +## Testing + +- [ ] I have tested this change locally +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings + +## Related Issues + +Closes #(issue) \ No newline at end of file diff --git a/SECURITY.md b/.github/SECURITY.md similarity index 100% rename from SECURITY.md rename to .github/SECURITY.md diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..2c23368 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,44 @@ +# Getting Help + +## Documentation + +Before asking for help, please check our documentation: + +- [README](../README.md) - Basic setup and usage +- [Wiki Documentation](https://github.com/evolvewithevan/gitcord/wiki) +- [API Reference](../docs/src/api-reference/) + +## Community Support + +### GitHub Issues + +For bugs, feature requests, or questions about the project: +- [Open an issue](https://github.com/evolvewithevan/gitcord/issues/new) +- Search existing issues first to avoid duplicates + +### GitHub Discussions + +For general questions, ideas, or community discussion: +- [Start a discussion](https://github.com/evolvewithevan/gitcord/discussions) + +## Contact + +### Project Maintainer +- **Email**: evolvewithevan@gmail.com +- **GitHub**: [@evolvewithevan](https://github.com/evolvewithevan) + +## Response Times + +- **Issues**: We aim to respond within 48 hours +- **Pull Requests**: We aim to review within 72 hours +- **Security Issues**: We aim to respond within 24 hours + +## Before You Ask + +Please include: +- GitCord version +- Python version +- Operating system +- Steps to reproduce (for bugs) +- Expected vs actual behavior +- Relevant logs or error messages \ No newline at end of file diff --git a/README.md b/README.md index 6961ccc..9c751bf 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ gitcord/ ## 🤝 Contributing -We welcome contributions! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for: +We welcome contributions! Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for: - Coding standards (PEP8, type hints, docstrings) - How to set up your dev environment - Testing and documentation guidelines diff --git a/src/gitcord/cogs/help.py b/src/gitcord/cogs/help.py index 94142c0..3225844 100644 --- a/src/gitcord/cogs/help.py +++ b/src/gitcord/cogs/help.py @@ -67,7 +67,7 @@ async def help_prefix(self, ctx: commands.Context) -> None: "• [Github Project](https://github.com/users/evolvewithevan/projects/4/views/1)\n" "• [Roadmap](https://github.com/users/evolvewithevan/projects/4/views/3)\n" "• [Wiki Documentation](https://github.com/evolvewithevan/gitcord/wiki)\n" - "• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/SECURITY.md)", + "• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/.github/SECURITY.md)", inline=False, ) @@ -125,7 +125,7 @@ async def help_slash(self, interaction: discord.Interaction) -> None: "• [Github Project](https://github.com/users/evolvewithevan/projects/4/views/1)\n" "• [Roadmap](https://github.com/users/evolvewithevan/projects/4/views/3)\n" "• [Wiki Documentation](https://github.com/evolvewithevan/gitcord/wiki)\n" - "• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/SECURITY.md)", + "• [Security Policy](https://github.com/evolvewithevan/gitcord/blob/main/.github/SECURITY.md)", inline=False, )