Skip to content

PyGeoWeaver Contributing Guide

Thank you for your interest in contributing to PyGeoWeaver! By contributing, you can help improve the library, add new features, fix bugs, and make it even more powerful and user-friendly. This guide will provide you with the necessary information and guidelines to contribute effectively.

Code Repository

The PyGeoWeaver code repository is hosted on GitHub at https://github.com/ESIPFed/pygeoweaver. This is where you will find the latest source code, project documentation, and issue tracker.

License

PyGeoWeaver is licensed under the MIT License. By contributing to PyGeoWeaver, you agree that your contributions will be licensed under the same license. Please read the LICENSE file for more details.

Ways to Contribute

There are several ways you can contribute to PyGeoWeaver:

  1. Reporting Issues: If you encounter any bugs, errors, or have suggestions for improvements, please open an issue on the issue tracker. Provide a clear and detailed description of the problem or enhancement you're suggesting.

  2. Fixing Issues: You can contribute by fixing existing issues listed on the issue tracker. Fork the repository, make the necessary changes in your forked repository, and submit a pull request with your changes.

  3. Adding Features: If you have an idea for a new feature or enhancement, please open an issue first to discuss it with the maintainers. Once the feature is approved, you can implement it and submit a pull request.

  4. Improving Documentation: Documentation is crucial for a successful open-source project. You can contribute by improving the existing documentation, adding examples, or writing tutorials.

Contributing Process

To contribute to PyGeoWeaver, follow these steps:

  1. Fork the Repository: Click on the "Fork" button on the PyGeoWeaver repository page to create a copy of the repository in your GitHub account.

  2. Clone the Repository: Clone the forked repository to your local development environment using the following command:

git clone https://github.com/your-username/pygeoweaver.git
  1. Create a Branch: Create a new branch for your contribution. Choose a descriptive branch name that reflects the nature of your changes.
git checkout -b your-branch-name

  1. Make Changes: Make the necessary changes in your local repository. Follow the coding style and guidelines specified in the project to ensure consistency.

  2. Test Your Changes: Run the tests and ensure that all existing tests pass. If applicable, add new tests to cover the changes you made.

  3. Commit and Push: Commit your changes and push them to your forked repository.

git commit -m "Your commit message"
git push origin your-branch-name

  1. Submit a Pull Request: Go to the PyGeoWeaver repository page on GitHub and click on the "New Pull Request" button. Provide a clear description of your changes and submit the pull request.

  2. Review and Iterate: The maintainers will review your pull request and provide feedback. Iterate on the changes based on the feedback until your contribution is ready to be merged.

  3. Congratulations!: Once your pull request is approved and merged, your contribution becomes part of PyGeoWeaver. Thank you for your valuable contribution!

Code of Conduct

We expect all contributors to adhere to the ESIP Code of Conduct

fed.org/careers-volunteers/code-of-conduct). Please ensure that you follow the code of conduct in all interactions and discussions related to the project.

Get Started

If you're ready to contribute, visit the PyGeoWeaver repository and start exploring the issues, documentation, and codebase. Your contributions will be greatly appreciated and will help make PyGeoWeaver even better!

Thank you for your interest and support in making PyGeoWeaver a powerful and collaborative geospatial workflow library. Happy contributing!