Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.76 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the TelegramMe API project! We welcome any contributions that improve the functionality, performance, or documentation of the project.

How to Contribute

To contribute to the TelegramMe API project, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution: 
    git checkout -b feature/your-feature-name
  4. Make your changes and commit them to your branch: 
    git commit -am 'Add some feature'
  5. Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  6. Open a pull request against the main branch of the original repository.

Development Setup

To set up the development environment for the TelegramMe API project, follow the instructions provided in the README.md file.

Code Style Guidelines

When contributing code to the project, please ensure that your code follows the PEP 8 style guide for Python code. Additionally, please write descriptive commit messages and maintain a clean commit history.

Testing

Before submitting a pull request, please ensure that your changes pass any existing tests and add new tests if necessary. You can run the tests locally using the following command:

# Assuming you have installed the project's dependencies
pytest

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on the GitHub repository.

License

By contributing to the TelegramMe API project, you agree that your contributions will be licensed under the project's GPL-3.0 License.