Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

115 lines (75 loc) · 3.5 KB

Contributing to CosmoBot

First off, thank you for considering contributing to CosmoBot! Your time and efforts are greatly appreciated. This guide will help you get started with contributing to the project.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Getting Started
  4. Style Guidelines
  5. Pull Request Process
  6. License

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please be respectful and considerate to others in all interactions.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue on GitHub. Include as much detail as possible:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Any relevant log output or screenshots.
  • The version of CosmoBot and your environment setup (e.g., Python version, Discord.py version).

Suggesting Features

We welcome feature requests! If you have an idea for improving CosmoBot, please open an issue on GitHub and:

  • Explain the problem your feature would solve.
  • Describe the proposed solution.
  • Mention any alternatives you've considered.

Contributing Code

We welcome contributions from everyone, whether you're fixing a bug or adding a new feature. Please ensure that your code follows our Style Guidelines.

Getting Started

Setting Up the Development Environment

  1. Fork the repository to your GitHub account.

  2. Clone your fork to your local machine:

    git clone https://github.com/YOUR-USERNAME/CosmoBot.git

Install the dependencies:

pdm install requirements.txt

Set up environment variables:

Create a .env file in the root of the project and add your Discord bot token and other necessary configurations.

DISCORD_BOT_TOKEN=your_discord_bot_token_here

Run the bot locally to ensure everything is set up correctly:

python main.py

Making Your Changes

Create a new branch for your feature or bugfix:

git checkout -b feature/your-feature-name

Make your changes, and ensure the bot runs correctly.

Commit your changes with a descriptive message:

git commit -m "Add feature: Your feature description"

Push your changes to your forked repository:

git push origin feature/your-feature-name

Open a Pull Request on the original repository.

Style Guidelines

  • Code Style: Follow PEP 8 for Python code.
  • Docstrings: Use Google Style Docstrings.
  • Commit Messages: Write clear and concise commit messages. Use the present tense ("Add feature" not "Added feature").

Pull Request Process

  1. Ensure your branch is up-to-date with the main branch.
  2. Submit a detailed Pull Request on GitHub, describing your changes.
  3. A project maintainer will review your PR. Please be patient and responsive to feedback.
  4. Once approved, your PR will be merged into the main branch.

License

By contributing to CosmoBot, you agree that your contributions will be licensed under the AGPL-3.0 License.