Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

77 lines (57 loc) · 2.89 KB
Raw

Contributing to AutoVox

We’re excited that you want to contribute to AutoVox! Below are the guidelines for contributing to the project. Please take the time to review them before making your contribution.

How to Contribute

  1. Fork the Repository

    • Navigate to the main repository page, click the "Fork" button in the top right corner to create your own copy of the repo.

  2. Clone the Repository

    • Clone your forked repository to your local machine: 
      git clone https://github.com/your-username/AutoVox.git

  3. Create a New Branch

    • Make sure you’re on the main branch: 
      git checkout main
    • Create a new branch for your changes: 
      git checkout -b feature/your-feature-name

  4. Make Your Changes

    • Implement your changes or add new features, keeping in mind the coding standards of the project.

  5. Test Your Changes

    • Ensure your changes work as expected by running tests or testing the bot locally. Avoid submitting code that hasn't been tested.

  6. Commit Your Changes

    • Write clear and concise commit messages: 
      git commit -m "Add feature XYZ"

  7. Push Your Changes

    • Push your branch to GitHub: 
      git push origin feature/your-feature-name

  8. Submit a Pull Request

    • Navigate to your forked repository on GitHub.
    • Click the “Compare & pull request” button.
    • Provide a description of your changes and submit your pull request to the main branch of the original repository.

Code Style Guidelines

  • Follow Python's PEP 8 style guide.
  • Use meaningful and descriptive variable, function, and class names.
  • Ensure your code is well-documented, including comments where necessary.
  • Avoid unnecessary large commits by breaking down your work into small, logical steps.

Pull Request Process

  • All pull requests should be reviewed by at least one project maintainer before being merged.
  • Ensure your pull request description clearly explains the issue or feature being addressed.
  • Reference any related issue or bug report by adding the issue number to your PR description (e.g., "Closes #123").
  • You may be asked to make changes before your pull request is accepted.

Reporting Issues

If you find a bug or have a suggestion, please open an issue in the repository. When reporting an issue, please include:

  • A clear and descriptive title.
  • Detailed steps to reproduce the problem (if applicable).
  • Relevant logs or screenshots.
  • Your environment (e.g., Python version, OS, Discord version, etc.).

Code of Conduct

We strive to foster an open and welcoming community. By participating in this project, you agree to adhere to our Code of Conduct.

Thank you for contributing to AutoVox! Your support and involvement help make the project better.