Thank you for considering contributing to PyOsmoGPS! We welcome contributions in the form of issues, feature requests, and pull requests. This guide will help you get started.
If you encounter a bug or have a suggestion for improvement, please create an issue on GitHub. When reporting an issue, please include as much detail as possible:
- A clear and descriptive title.
- A detailed description of the problem or suggestion.
- Steps to reproduce the issue (if applicable).
- Any relevant logs, screenshots, or error messages.
If you have an idea for a new feature or an enhancement to an existing feature, please create a feature request issue on GitHub. Provide a clear and detailed description of the feature, including:
- The motivation for the feature.
- How the feature would be used.
- Any potential challenges or considerations.
We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request:
- Fork the repository and clone your fork.
- Create a new branch for your changes:
git checkout -b my-feature-branch
- Make your changes, ensuring that your code follows the project's coding standards.
- Commit your changes with a clear and descriptive commit message:
git commit -m "Add new feature X" - Push your changes to your fork:
git push origin my-feature-branch
- Create a pull request on GitHub, providing a clear and detailed description of your changes.
Please ensure that your code follows the project's coding standards. This includes:
- Writing clear and concise code.
- Adding comments to explain complex logic.
- Writing tests for new features and bug fixes.
- Running existing tests to ensure that your changes do not introduce any regressions.
By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others in all interactions.
If you need help or have questions, feel free to reach out by creating an issue on GitHub. We will do our best to assist you.
Thank you for contributing to PyOsmoGPS!