Contributing

The smodex package is an open source package and is open to receiving contributions and extension to make the package better and to serve the broader community of students, researchers and users. Anything contribution is greatly appreciated. We have prepared a few guidelines that we need our contributors to follow to help us better manage the package and integrate new ideas.

Type of contributions

We are open to receiving contributions to improve the functionalities and use of the package and currently have the following areas on our priority list:

  1. Review: We must general comments and conceptual feedback on the package and structure,

  2. New functionalities: we equally welcome ideas and concepts for potential new functions for the earth observation community and a make pull request with the new function,

  3. Bugs: If any of the functions are not working, kindly open an issue to report the bug and we will be sure to fix it,

  4. Fix Bugs: Even better, make a pull request to help us fix the bugs you noticed,

Getting started

  1. Create an issue if one does not exist yet

    • Clearly describe the issues including the steps to reproduce it when it is a bug,

    • Ensure you fill in the earliest version that you know has the issue

  2. Fork the repository on your GitLab account

  3. Developing your changes:

    • Create a topic branch where you want to base your work,

    • Ensure you run the pre-commit hook before making a commit (install pre-commit),

    • Run the test

pytest tests/*

  1. Submitting changes

    • Push your changes to a topic branch in your fork of the repository,

    • Submit a Pull request to the repo of the smodex package,

    • Update the issue to show that you have submitted code and ready for Merge review,

    • Our developers will take a look at your code and give responses to your changes