66 lines
2.1 KiB
Markdown
66 lines
2.1 KiB
Markdown
# Contributing to discoBase
|
|
|
|
First of all, thank you for considering contributing to discoBase! Your support helps improve this package and make it better for everyone.
|
|
|
|
## How Can You Contribute?
|
|
|
|
- Reporting bugs
|
|
- Suggesting features
|
|
- Submitting code improvements or new features
|
|
- Improving documentation
|
|
|
|
## Guidelines for Contribution
|
|
|
|
### 1. Reporting Bugs
|
|
|
|
If you find a bug, please report it by opening an [issue]([https://github.com/your-repo/discoBase/issues](https://github.com/ethical-programmer/discobase/issues)). Provide as much detail as possible:
|
|
|
|
- Steps to reproduce the bug
|
|
- Version of discoBase you're using
|
|
- Any error logs
|
|
|
|
### 2. Suggesting Features
|
|
|
|
Do you have an idea for a new feature? We'd love to hear it! Open an [issue]([https://github.com/your-repo/discoBase/issues](https://github.com/ethical-programmer/discobase/issues)) and explain the feature you'd like to see, along with any use cases.
|
|
|
|
### 3. Submitting Code Changes
|
|
|
|
To submit a code change:
|
|
|
|
1. **Fork the repository** on GitHub.
|
|
2. **Clone your fork** locally:
|
|
```bash
|
|
git clone https://github.com/ethical-programmer/discobase
|
|
```
|
|
3. **Create a new branch** for your changes:
|
|
```bash
|
|
git checkout -b feature/your-feature
|
|
```
|
|
4. **Make your changes** to the codebase.
|
|
5. **Commit your changes**:
|
|
```bash
|
|
git commit -m "Added a cool new feature"
|
|
```
|
|
6. **Push to your branch**:
|
|
```bash
|
|
git push origin feature/your-feature
|
|
```
|
|
7. **Open a Pull Request** on GitHub.
|
|
|
|
### 4. Coding Standards
|
|
|
|
- Use consistent formatting and indentation.
|
|
- Write clear, concise commit messages.
|
|
- Make sure your code is well-documented and includes comments where necessary.
|
|
|
|
### 5. Testing Your Changes
|
|
|
|
Ensure that your changes do not introduce any errors or issues by thoroughly testing them before submitting. You can run the project locally to verify this.
|
|
|
|
### 6. Improving Documentation
|
|
|
|
Even if you're not a developer, improving the documentation is a great way to contribute! You can submit fixes for typos or add missing sections that help other users understand the project better.
|
|
|
|
---
|
|
|
|
Thank you for taking the time to contribute! |