Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.8 KB

Contributing to CapyBot

Thank you for considering contributing to CapyBot! We welcome contributions from everyone, whether you're a seasoned developer or just getting started.

How You Can Contribute

There are several ways you can help make CapyBot even better:

  1. Reporting Bugs: If you encounter any issues, please report them by creating an issue. Provide as much detail as possible, including steps to reproduce the bug and any relevant logs or screenshots.

  2. Suggesting Features: Have an idea for a new feature or an enhancement? We'd love to hear it! Open a feature request issue, and let's discuss how we can bring it to life.

  3. Improving Documentation: Good documentation is crucial. If you spot any errors, inconsistencies, or areas that could use more clarity, please submit a pull request with your improvements.

  4. Submitting Code: If you want to contribute code, follow these steps:

    • Fork the repository.
    • Create a new branch with a descriptive name (e.g., fix-issue-123 or add-new-feature).
    • Write tests for your changes if applicable.
    • Commit your changes with clear and concise messages.
    • Push your branch to your forked repository.
    • Create a pull request from your branch to the main repository. Provide a detailed description of the changes you've made.

  5. Reviewing Pull Requests: If you're interested in reviewing code, we appreciate the extra set of eyes. Feel free to review open pull requests and provide feedback.

Getting Started

To get started with CapyBot development, follow these steps:

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies using your preferred package manager.
  3. Follow the setup instructions in the README.md to get the project running locally.