Skip to content

Commit

Permalink
chore: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
lukazbaum committed Jan 24, 2024
0 parents commit 6c9e921
Show file tree
Hide file tree
Showing 50 changed files with 2,308 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
CLIENT_TOKEN=
CLIENT_ID=
GUILD_ID=
43 changes: 43 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Code of Conduct

## Purpose

The community is dedicated to creating a welcoming, inclusive, and respectful environment for everyone involved. This Code of Conduct outlines our shared values and the standards we expect from all community members.

## Our Values

1. **Inclusivity:** We welcome individuals from all backgrounds and experiences. Diversity enriches our community, and we strive to make everyone feel valued and included.

2. **Respect:** Treat others with kindness, empathy, and respect. Disagreements may arise, but it's essential to maintain a courteous and constructive atmosphere.

3. **Collaboration:** Foster a spirit of collaboration and teamwork. Together, we can achieve more and create a positive impact on the community.

4. **Open-Mindedness:** Embrace diverse perspectives and ideas. Be open to learning from others and adapting to new approaches.

5. **Constructive Feedback:** Provide feedback in a constructive manner. Help each other improve and grow without undermining or belittling.

## Unacceptable Behavior

The following behaviors are considered unacceptable within the Discord Bot Handler community:

1. **Harassment:** Any form of harassment, discrimination, or unwelcome behavior is strictly prohibited. This includes but is not limited to offensive language, intimidation, or any other harmful actions.

2. **Disrespectful Conduct:** Treating others disrespectfully, whether through language, actions, or tone, is not tolerated.

3. **Trolling or Flaming:** Deliberately provocative, offensive, or inflammatory comments or actions are not allowed.

4. **Impersonation:** Impersonating others or creating misleading profiles is not allowed.

5. **Spam and Advertising:** Excessive self-promotion, spam, or unrelated advertising is not permitted.

## Reporting Violations

If you witness or experience any behavior that violates this Code of Conduct, please report it to the project maintainers promptly. You can contact us via [Discord](https://discord.com/users/lukasbaum).

## Enforcement

Project maintainers have the right and responsibility to address any reported violations. Actions may include warnings, temporary or permanent bans from the community, or other appropriate responses.

## Acknowledgment

By participating in the Discord Bot Handler community, you agree to abide by this Code of Conduct. We appreciate your commitment to fostering a positive and inclusive environment for all.
53 changes: 53 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing to Discord Bot Handler

We're excited that you're interested in contributing to our Discord Bot Handler project! This document provides guidelines for contributing and aims to make the contribution process as smooth and pleasant as possible.

## Getting Started

Before you begin, make sure you have:

- A GitHub account
- Basic knowledge of TypeScript and Discord bot development
- Familiarity with the project's codebase (read through the documentation)

## How to Contribute

You can contribute in several ways:

1. **Reporting Bugs:**
- Use the GitHub Issues section to report bugs.
- Clearly describe the issue, including steps to reproduce and the expected outcome.
- Include screenshots or code snippets if applicable.

2. **Suggesting Enhancements:**
- Submit enhancement suggestions through GitHub Issues.
- Provide a clear description of the enhancement and its benefits.

3. **Pull Requests:**
- Fork the repository and create your branch from `main`.
- Write clear, concise code and ensure it adheres to the project's coding standards.
- Write a clear, detailed pull request description explaining your changes.
- Ensure your code does not introduce new issues.

## Coding Standards

- Follow the existing code style.
- Use meaningful variable and function names.
- Comment your code where necessary.
- Keep your changes concise and focused on solving a single problem.

## Pull Request Process

1. Update the README.md with details of changes if necessary.
2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request represents.
3. Your pull request will be reviewed by the maintainers, who may request changes or provide feedback. Be responsive to feedback to ensure a swift review process.

## Community Guidelines

Be respectful and inclusive. Treat everyone with respect and kindness, and foster an environment of collaboration and learning.

## Questions?

If you have any questions or need assistance, feel free to reach out to the maintainers via [Discord](https://discord.com/users/lukasbaum).

Thank you for your interest in contributing to our Discord Bot Handler, and we look forward to your contributions!
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG]'
labels: 'bug'
assignees: ''

---

# Bug Report

## Description
Please provide a clear and concise description of what the bug is.

## To Reproduce
Describe the steps to reproduce the behavior:
1. Provide context on what you were trying to achieve.
2. Specify the command or interaction used.
3. Outline any parameters or options you included.
4. Describe the unexpected behavior or error encountered.

## Expected Behavior
A clear and concise description of what you expected to happen.

## Screenshots
If applicable, add screenshots to help explain your problem.

## Environment (please complete the following information):
- OS: [e.g., Windows, macOS, Linux]
- Version of Discord Bot Handler:
- Version of Node.js:

## Additional Context
Add any other context about the problem here. This could include the section of the code you suspect is causing the issue, any log files, or anything else that might be relevant.

## Possible Solution (optional)
If you have a suggestion for how to fix the issue, please describe it here.

---

Thank you for taking the time to report a bug. Your feedback is valuable to us and helps improve the quality of the Discord Bot Handler.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/CODE_IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Code Improvement/Suggestion
about: Propose improvements or suggest changes to the Discord Bot Handler's codebase
title: '[IMPROVEMENT]: '
labels: 'code improvement', 'suggestion'
assignees: ''

---

**Describe Your Suggestion or Improvement**
A clear and concise description of the improvement or change you are proposing. Explain the problem or limitation you have identified, and how your suggestion addresses it.

**Code Segment (if applicable)**
If your suggestion involves specific code changes, provide a code snippet or reference to the relevant part of the codebase. This can help in understanding your proposed changes better.

**Benefits**
Explain how your suggested improvement benefits the Discord Bot Handler in terms of performance, maintainability, readability, or any other relevant aspect.

**Potential Drawbacks**
Are there any potential downsides or drawbacks to your suggestion that should be considered? If so, please mention them.

**Additional Context**
Provide any additional context or information that can help in understanding the context of your suggestion.

**Would you like to work on this improvement?**
- [ ] Yes
- [ ] No
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION_IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Documentation Improvement
about: Suggest an improvement or report an issue in the documentation
title: '[DOC]: '
labels: 'documentation'
assignees: ''

---

**Describe the Improvement or Issue**
A clear and concise description of what the improvement is or what the issue with the current documentation is. If it's an issue, please explain how it can be misleading, incomplete, or incorrect.

**Suggested Change or Addition**
If you have a specific suggestion or content to add, please outline it here. Be as detailed as possible.

**Additional Context**
Add any other context, links, or screenshots about the documentation improvement here. If this is regarding a specific section or page in the documentation, please provide a direct link.

**Would you like to work on it?**
- [ ] Yes
- [ ] No
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: 'enhancement'
assignees: ''

---

## Feature Description
A clear and concise description of what the feature is.

## Problem and Motivation
Describe the problem you're trying to solve with this feature. Explain why this feature is important for the project.

## Proposed Solution
If you have an idea of how to implement this feature, please share it here. Details on how you envision it working are helpful.

## Alternatives Considered
Have you considered any alternatives that could solve the same problem? If so, please describe them.

## Additional Context
Add any other context or screenshots about the feature request here. If this feature is inspired by something else, please provide references.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION_SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Question/Support
about: Ask a question or seek support regarding the Discord Bot Handler
title: '[SUPPORT]: '
labels: 'question', 'support'
assignees: ''

---

**Describe Your Question or Issue**
A clear and concise description of what the question or issue is. Please provide as much context as possible to help us understand your situation better.

**What Have You Tried?**
Outline any steps you have taken to resolve or understand the issue on your own. This helps us to provide more targeted assistance.

**Expected Behavior**
If applicable, describe what you expected to happen.

**Screenshots/Code Snippets**
If you think it would be helpful, add screenshots of the issue or code snippets that demonstrate the problem or part of your question.

**Environment (please complete the following information):**
- OS: [e.g., Windows, MacOS, Linux]
- Discord Bot Handler Version:
- Node.js Version:
- Discord.js Version:

**Additional Context**
Add any other context or details about the question or issue here.

**Would you like to be contacted for further support?**
- [ ] Yes
- [ ] No
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.idea/
.vscode/
dist/
node_modules/
.env
package-lock.json
yarn.lock
25 changes: 25 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "discordjs-command-handler",
"version": "1.0.0",
"description": "A comprehensive TypeScript command handler for Discord.js, featuring slash commands, prefix commands, message events, automatic intents, and more.",
"main": "src/index.ts",
"scripts": {
"clean": "rm -rf dist",
"compile": "npm run clean && tsc",
"start": "node dist/index.js",
"watch": "tsc -w",
"cs": "npm run compile && npm run start"
},
"keywords": [],
"author": "Lukas Baum",
"license": "MIT",
"devDependencies": {
"@types/node": "^20.11.6",
"typescript": "^5.3.3"
},
"dependencies": {
"discord.js": "^14.14.1",
"dotenv": "^16.4.0",
"glob": "^10.3.10"
}
}
Loading

0 comments on commit 6c9e921

Please sign in to comment.