Skip to content

Commit 8532c52

Browse files
aaronaalmendarezaaronaalmendarez
committed
chore: Achieve GitHub Community Standards by adding policies and templates
1 parent a86b56c commit 8532c52

File tree

7 files changed

+178
-10
lines changed

7 files changed

+178
-10
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve.
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots/Logs**
23+
If applicable, add screenshots or logs to help explain your problem.
24+
25+
**Environment (please complete the following information):**
26+
- Minecraft Version: [e.g. 1.21.1]
27+
- Fabric Loader Version: [e.g. 0.18.4]
28+
- Mod Version: [e.g. 1.0.0]
29+
- Other mods installed: [e.g. Sodium, Iris]
30+
31+
**Additional context**
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project.
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Description
2+
Briefly describe the changes introduced by this Pull Request.
3+
4+
## Related Issue
5+
Fixes # (issue)
6+
7+
## Type of Change
8+
- [ ] Bug fix (non-breaking change which fixes an issue)
9+
- [ ] New feature (non-breaking change which adds functionality)
10+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
- [ ] Documentation update
12+
13+
## Checklist:
14+
- [ ] My code follows the style guidelines of this project.
15+
- [ ] I have performed a self-review of my own code.
16+
- [ ] I have commented my code, particularly in hard-to-understand areas.
17+
- [ ] I have made corresponding changes to the documentation.
18+
- [ ] My changes generate no new warnings.
19+
- [ ] New and existing tests pass locally with my changes.

‎CODE_OF_CONDUCT.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎CONTRIBUTING.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Gemini AI Companion
2+
3+
First off, thank you for considering contributing to Gemini AI Companion! It's people like you that make this mod a great tool for everyone.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## How Can I Contribute?
10+
11+
### Reporting Bugs
12+
13+
Before creating bug reports, please check the [Issue Tracker](https://github.com/aaronaalmendarez/gemini-minecraft/issues) to see if the problem has already been reported.
14+
15+
When you are creating a bug report, please include as many details as possible:
16+
* **Use a clear and descriptive title**
17+
* **Describe the exact steps which reproduce the problem**
18+
* **Provide log files** from `.minecraft/logs/`
19+
* **Mention your game and loader version** (e.g., Minecraft 1.21.1, Fabric 0.18.4)
20+
21+
### Suggesting Enhancements
22+
23+
We're always looking for new ideas! Please open a "Feature Request" issue to discuss your proposal.
24+
25+
## Pull Request Process
26+
27+
1. **Fork the repository** and create your branch from `main`.
28+
2. **Follow the existing code style**:
29+
- Use Java 21 features where appropriate.
30+
- Maintain the modular structure in `com.aaron.gemini`.
31+
- Document new functions and complex logic.
32+
3. **Tests**: Ensure your changes don't break existing functionality.
33+
4. **Documentation**: Update the README or other documentation if your changes introduce new features.
34+
5. **Issue link**: Reference the issue your PR addresses in the description.
35+
36+
## Development Setup
37+
38+
The project uses Gradle. You can set it up in your IDE (IntelliJ IDEA recommended):
39+
1. Clone the repo.
40+
2. Select `build.gradle` and "Open as Project".
41+
3. Run `./gradlew genSources` to set up the Fabric environment.
42+
43+
Thank you for your contributions! ❤️

‎README.md‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -317,16 +317,7 @@ The journey to true digital agency is just beginning. Here is where we're headed
317317

318318
## 🤝 Contributing
319319

320-
Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
321-
322-
1. Fork the Project
323-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
324-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
325-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
326-
5. Open a Pull Request
327-
328-
> [!NOTE]
329-
> Please open an issue first for major changes to ensure alignment with the project's vision.
320+
Contributions are what make the open-source community an amazing place to learn, inspire, and create. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get started.
330321

331322
---
332323

‎SECURITY.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
The following versions of Gemini AI Companion are currently being supported with security updates.
6+
7+
| Version | Supported |
8+
| ------- | --------- |
9+
| v1.0.x | ✅ Yes |
10+
| < v1.0 | ❌ No |
11+
12+
## Reporting a Vulnerability
13+
14+
We take the security of this project seriously. If you believe you have found a security vulnerability, please do NOT open a public issue.
15+
16+
Instead, please report it privately:
17+
1. **Email**: [Add your email here or use GitHub Private Reporting]
18+
2. **Details**: Provide a detailed description of the vulnerability and steps to reproduce.
19+
20+
We will acknowledge your report within 48 hours and provide a timeline for a fix if the vulnerability is confirmed. Thank you for helping keep the community safe!

0 commit comments

Comments
 (0)