@shadow-dev/core
Version:
A modular core framework for Discord bot development, providing commands, buttons, menus, middleware, and more.
48 lines (37 loc) • 1.43 kB
Markdown
## How to Contribute
To contribute to ShadowCore, please follow these steps:
### 1. **Fork the Repository**
Click the **Fork** button at the top of the [ShadowCore GitHub repository](https://github.com/your-username/ShadowCore) to create your own copy.
### 2. **Clone Your Fork**
Clone the repository to your local machine:
```bash
git clone https://github.com/your-username/ShadowCore.git
cd ShadowCore
```
### 3. **Create a New Branch**
Follow the naming convention:
- `feat/branch-name` → For new features
- `fix/branch-name` → For bug fixes
- `docs/branch-name` → For documentation updates
```bash
git checkout -b feat/your-feature-name
```
### 4. **Make Changes and Commit**
Modify the necessary files and commit your changes using a clear commit message:
```bash
git commit -m "feat: Add new feature description"
```
### 5. **Push Your Changes**
```bash
git push origin feat/your-feature-name
```
### 6. **Submit a Pull Request (PR)**
1. Go to your fork on GitHub.
2. Click **"Compare & pull request"**.
3. fill out the PR template, describe your changes, and submit it for review.
### ✅ **Contribution Guidelines**
✔ Follow the project's coding style and ESLint rules.
✔ Keep PRs focused and concise (1 feature/bugfix per PR).
✔ Write clear commit messages.
✔ Ensure your changes do not introduce new security vulnerabilities.
✔ Be respectful and collaborative in code reviews.