Thank you for considering contributing to our project! We welcome contributions from everyone. Please follow the guidelines below to help us maintain a high-quality codebase and a positive community.
Start by forking the repository to your own GitHub account. This allows you to make changes without affecting the original project.
Clone your forked repository to your local machine: git clone https://github.com/mmabiaa/Python_Beginner_Projects.git
Create a new branch for your feature or bug fix: git checkout -b feature/my-feature
Make the necessary changes in your local repository. Ensure that you follow the coding standards outlined below.
Before submitting your changes, make sure to test them thoroughly. Ensure that all features work as expected and that no new bugs are introduced.
Commit your changes with a clear and descriptive commit message: git commit -m “Add feature: my-feature”
Push your changes back to your forked repository: git push origin feature/my-feature
Navigate to the original repository and create a pull request (PR) from your branch. Provide a detailed description of your changes and why they should be merged.
- Python Version: Ensure your code is compatible with Python 3.x.
- Code Style: Follow PEP 8 for Python code style.
- Documentation: Add comments and documentation where necessary, especially for complex logic.
- Testing: If you add new features, consider adding tests to ensure they work as intended.
If you encounter any bugs or have suggestions for improvements, please open an issue in the repository. Provide as much detail as possible, including steps to reproduce any bugs.
We strive to maintain a welcoming and inclusive community. Please be respectful and considerate in all interactions, whether in issues, pull requests, or discussions.
By contributing to this project, you agree that your contributions will be licensed under the project's license (see LICENSE file).
Thank you for contributing!