Thank you for considering contributing to FahimFBA/python! We value all the help we can get from the community. This document provides guidelines to help you contribute effectively.
Before contributing, please read our Code of Conduct. We expect all contributors to adhere to this code.
- Fork the Repository: Click on the 'Fork' button at the top right corner of the repository page.
- Clone Your Fork: Clone your forked repository to your local machine.
- Reporting Bugs: If you find a bug, please create an issue in the repository. Provide a clear description of the bug, steps to reproduce it, and any relevant information.
- Requesting Features: If you have a feature request, please create an issue. Explain the feature you'd like to see, why you need it, and how it should work.
- Before Submitting: Ensure your code follows the Code Style guidelines.
- Title and Description: Provide a clear and concise title and description for your pull request. Include the issue number if applicable.
- Testing: Make sure to test your changes thoroughly. Include tests if possible.
- Documentation: Update the documentation if your changes affect the user interface or functionality.
- Python: Follow the PEP 8 style guide for Python code.
- Comments: Use comments to explain your code, but make sure the code is self-explanatory as much as possible.
- Unit Tests: Write unit tests for your code. Ensure all tests pass before submitting a pull request.
- Continuous Integration: We use GitHub Actions for continuous integration. Make sure your pull request passes all checks.
- Update README: If your changes affect the project's functionality, update the README accordingly.
- Comments in Code: Document your code with comments, especially for complex logic.
Thank you for considering contributing to FahimFBA/python! We look forward to your contributions. If you have any questions, feel free to ask.