Skip to content

Contributor guide

Thank you for your interest in contributing to earthaccess! We're excited for your contribution, whether you're finding bugs, adding new features, fixing anything broken, or improving documentation.

When contributing we recommend:

  • reading the contributing guide all the way though once before starting
  • join us on Zulip chat for any questions you may have
  • searching through issues, discussions, pull requests, and Zulip to see if your contribution has already been discussed so you don't duplicate work

Then, you can:

  • Open a GitHub issue to report a bug, unexpected behavior, a stumbling block in our documentation, or any other problem.
  • Open a Q&A GitHub Discussion to ask questions, share insights, or connect with others about Earth data access (broadly)
  • Open an Ideas GitHub Discussion to suggest new features or improvements, and find collaborators and coordinate the work
  • Join a Collaboration Café to meet other users/developers/maintainers and get help on, or give help to, anything related to Earth data access

You can also open a pull request! Please review our pull request guide first.

If you're not sure what to do, don't worry, and just pick whichever suits you best. The community will help you out!

New to contributing? You're welcome here!

If you're not comfortable writing unit tests, debugging CI failures, or setting up a development environment — we still want your contribution! Open a pull request with what you have, ask for help, and someone from the community will do their best to work with you. Bug fixes and features do need tests before they can be merged, but you don't have to write them on your own. See our pull request guide and the PR checklist for details.

Note

We have a code of conduct. Please follow it in all of your interactions with the project.