Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 2.58 KB
Raw

Contributing to ReVot

First off, thank you for considering contributing to ReVot! It's people like you that make this project possible.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Please include as much detail as possible, including steps to reproduce the issue, your environment, and any relevant logs or screenshots.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue on our GitHub repository. Describe your idea in detail and explain why you think it would be a good addition to the project.

Pull Requests

We welcome pull requests from everyone. Here are some guidelines to follow:

  1. Fork the repository and clone it to your local machine.

    git clone https://github.com/<username_of_contributer>/ReVot.git
cd ReVot

  2. Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name

  3. Make your changes. Ensure your code follows the project's coding standards and includes appropriate tests.

  4. Commit your changes with a clear and descriptive commit message.

    git commit -m "Add feature: your-feature-name"

  5. Push your changes to your forked repository.

    git push origin feature/your-feature-name

  6. Open a pull request on the main repository. Provide a clear and detailed description of your changes and why they should be merged.

Code Style

Please follow the coding style used in the project. This includes:

  • Using meaningful variable and function names.
  • Adding comments to explain complex logic.
  • Keeping functions and methods short and focused.

Running Tests

Before submitting your pull request, make sure all tests pass. You can run the tests using the following command:

python -m unittest discover

Documentation

If your changes affect the usage or functionality of the project, please update the documentation accordingly. This includes updating the README.md file and any other relevant documentation files.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Getting Help

If you need help or have any questions, feel free to open an issue on our GitHub repository or contact me via Telegram.

Thank you for contributing!