|
1 |
| -# Contributing to PatternsHub: Python Design Patterns |
| 1 | +# Contributing to PatternsHub: Python Design Patterns 🎨 |
2 | 2 |
|
3 |
| -Thank you for your interest in contributing to PatternsHub! We welcome contributions from everyone and value your effort to improve this project. |
| 3 | +Thank you for your interest in contributing to PatternsHub! We welcome contributions from everyone and truly value your efforts to improve this project. 🚀 |
4 | 4 |
|
5 | 5 | ## How to Contribute
|
6 | 6 |
|
7 |
| -1. **Fork the repo**: Make a copy of this repository to your own GitHub account. |
8 |
| -2. **Create your feature branch**: (`git checkout -b feature/YourFeatureName`). |
9 |
| -3. **Make your changes**: Add or edit the content as needed. |
10 |
| -4. **Commit your changes**: (`git commit -am 'Add some feature'`). |
11 |
| -5. **Push to the branch**: (`git push origin feature/YourFeatureName`). |
12 |
| -6. **Create a new Pull Request**: Submit your changes for review. |
| 7 | +1. **Fork the repo** 🍴: Make a copy of this repository to your own GitHub account. |
| 8 | +2. **Create your feature branch** 🔀: (`git checkout -b feature/YourFeatureName`). |
| 9 | +3. **Make your changes** ✍️: Add or edit the content as needed. |
| 10 | +4. **Commit your changes** 💾: (`git commit -am 'Add some feature'`). |
| 11 | +5. **Push to the branch** 📤: (`git push origin feature/YourFeatureName`). |
| 12 | +6. **Create a new Pull Request** 📝: Submit your changes for review. |
13 | 13 |
|
14 | 14 | ## Pull Request Guidelines
|
15 | 15 |
|
16 |
| -- Ensure your code follows the basic Python coding conventions. |
17 |
| -- Write clear, descriptive commit messages. |
18 |
| -- Make sure your changes do not break the existing functionality. |
19 |
| -- Update the README.md with details of changes if applicable. |
| 16 | +- Ensure your code follows the basic Python coding conventions. 🐍 |
| 17 | +- Write clear, descriptive commit messages. 📄 |
| 18 | +- Ensure that your changes do not break the existing functionality. ✔️ |
| 19 | +- Update the README.md with details of changes if applicable. 📚 |
20 | 20 |
|
21 | 21 | ## Reporting Bugs
|
22 | 22 |
|
23 |
| -- Use the Issues section to report bugs. |
24 |
| -- Describe the bug and expected behavior. |
25 |
| -- Include steps to reproduce the bug. |
| 23 | +- Use the Issues section to report bugs. 🐛 |
| 24 | +- Describe the bug and the expected behavior. 📖 |
| 25 | +- Include steps to reproduce the bug. 🕵️♂️ |
26 | 26 |
|
27 |
| -## Styleguide |
| 27 | +## Style Guide |
28 | 28 |
|
29 |
| -- Follow standard Python PEP8 guidelines for styling your code. |
30 |
| -- Keep your code clean and well-commented. |
| 29 | +- Follow the standard Python PEP8 guidelines for styling your code. 📏 |
| 30 | +- Keep your code clean and well-commented. ✨ |
31 | 31 |
|
32 | 32 | ## License
|
33 | 33 |
|
34 |
| -By contributing, you agree that your contributions will be licensed under the MIT License. |
| 34 | +By contributing, you agree that your contributions will be licensed under the MIT License. 📜 |
35 | 35 |
|
36 |
| -Your contributions help make this project better and we truly appreciate them! |
| 36 | +We appreciate your contributions which help make this project better! ❤️ |
0 commit comments