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. 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 and explain the feature you'd like to see, along with any use cases.

3. Submitting Code Changes

To submit a code change:

Fork the repository on GitHub.

Clone your fork locally:

git clone https://github.com/ethical-programmer/discobase

Create a new branch for your changes:
```
git checkout -b feature/your-feature
```
Make your changes to the codebase.

Commit your changes:

git commit -m "Added a cool new feature"

Push to your branch:
```
git push origin feature/your-feature
```
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!

2.1 KiB Raw Blame History