Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

69 lines (51 loc) · 2.66 KB
Raw

Contributing to Telegram Security Bot

First off, thank you for considering contributing to the Telegram Security Bot project! Your contributions help make this project better for everyone.

How to Contribute

Reporting Issues

  • Check existing issues: Before reporting a new issue, please check if it has already been reported.
  • Provide detailed information: When reporting an issue, provide as much detail as possible, including steps to reproduce the problem, the context of the issue, and relevant screenshots or logs.

Submitting Pull Requests

  1. Fork the repository: Create a fork of the repository to work on your changes.

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

    git checkout -b feature/your-feature-name

  3. Make your changes: Implement your feature or fix in your branch.

  4. Test your changes: Ensure that your changes work as expected and do not break existing functionality.

  5. Commit your changes: Write clear and concise commit messages.

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

  6. Push your changes: Push your changes to your fork.

    git push origin feature/your-feature-name

  7. Create a pull request: Open a pull request to the main repository's main branch. Provide a clear description of your changes and reference any related issues.

Coding Standards

  • Follow Python conventions: Adhere to PEP 8 guidelines for Python code.
  • Write clear, concise code: Ensure your code is easy to read and understand.
  • Add comments: Comment your code where necessary to explain complex logic.

Testing

  • Write tests: Add tests for your changes to ensure they work as expected.
  • Run tests: Make sure all tests pass before submitting your pull request.

Code of Conduct

We expect all contributors to abide by our Code of Conduct. Please read it to understand the standards of behavior we expect from contributors.

Getting Started

To get started with contributing, follow the steps below:

  1. Clone the Repository: Clone the repository to your local machine. 
    git clone https://github.com/cleissonbarbosa/telegram-security-bot.git
cd telegram-security-bot
  2. Install Dependencies: Install the necessary dependencies. 
    pip install -r requirements.txt
  3. Run the Bot: Run the bot to ensure it works. 
    python src/main.py

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Feel free to review this draft and let me know if you would like any changes. Once approved, I can help you commit and push the file to the repository.