|
1 | | -# Contributing to Telegram Panel |
2 | | - |
3 | | -Thank you for your interest in contributing to Telegram Panel! This document provides guidelines and instructions for contributing. |
| 1 | +# Contributing |
4 | 2 |
|
5 | 3 | ## Getting Started |
6 | 4 |
|
7 | 5 | 1. Fork the repository |
8 | | -2. Clone your fork: `git clone https://github.com/your-username/Telegram-Panel.git` |
9 | | -3. Create a branch: `git checkout -b feature/your-feature-name` |
10 | | -4. Make your changes |
11 | | -5. Test your changes |
12 | | -6. Commit: `git commit -m "Add your feature"` |
13 | | -7. Push: `git push origin feature/your-feature-name` |
14 | | -8. Open a Pull Request |
| 6 | +2. Create a feature branch: `git checkout -b feature/your-feature` |
| 7 | +3. Make your changes |
| 8 | +4. Test: `pytest tests/` |
| 9 | +5. Commit: `git commit -m "Add feature"` |
| 10 | +6. Push: `git push origin feature/your-feature` |
| 11 | +7. Open a Pull Request |
15 | 12 |
|
16 | 13 | ## Code Style |
17 | 14 |
|
18 | | -- Follow PEP 8 style guide |
19 | | -- Use meaningful variable and function names |
20 | | -- Add docstrings to functions and classes |
21 | | -- Keep functions focused and small |
22 | | -- Use type hints where helpful |
23 | | - |
24 | | -## Testing |
25 | | - |
| 15 | +- Follow PEP 8 |
| 16 | +- Use meaningful names |
| 17 | +- Add docstrings |
26 | 18 | - Write tests for new features |
27 | | -- Ensure all existing tests pass |
28 | | -- Run tests before submitting: `pytest tests/` |
29 | | -- Aim for high test coverage |
30 | 19 |
|
31 | 20 | ## Commit Messages |
32 | 21 |
|
33 | | -- Use clear, descriptive commit messages |
34 | | -- Start with a verb (Add, Fix, Update, Remove, etc.) |
35 | | -- Keep the first line under 50 characters |
36 | | -- Add more details in the body if needed |
37 | | - |
38 | | -## Pull Request Process |
39 | | - |
40 | | -1. Update README.md if needed |
41 | | -2. Add tests for new functionality |
42 | | -3. Ensure all tests pass |
43 | | -4. Update documentation |
44 | | -5. Request review from maintainers |
45 | | - |
46 | | -## Reporting Issues |
47 | | - |
48 | | -When reporting issues, please include: |
49 | | -- Description of the problem |
50 | | -- Steps to reproduce |
51 | | -- Expected behavior |
52 | | -- Actual behavior |
53 | | -- Environment details (OS, Python version, etc.) |
54 | | -- Relevant logs |
55 | | - |
56 | | -## Questions? |
57 | | - |
58 | | -Feel free to open an issue for questions or discussions. |
59 | | - |
| 22 | +- Clear and descriptive |
| 23 | +- Start with a verb (Add, Fix, Update, etc.) |
| 24 | +- Keep first line under 50 characters |
0 commit comments