Skip to content

Latest commit

 

History

History
50 lines (43 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

50 lines (43 loc) · 2.41 KB
Raw

Contributing Guide

🎉 First off, thank you for considering contributing to our project! 🎉

These are some of the many ways to contribute:

  • 🙏🏽: Request a wallpaper
  • 🐛: Report or fix an error/typo/bug
  • 🖼️: Contribute a new wallpaper (see below)

For wallpaper requests 🙏🏽 and bug reports 🐛, open an Issue on GitHub. Please select the appropriate category if you can.

Contributing a wallpaper

New wallpapers are welcome through pull requests on GitHub. To do so, please follow these steps (assuming that you're familiar with git/GitHub):

  1. Fork the repository
  2. Create a new branch (avoid sending PRs from your "main" branch)
  3. Copy one of the notebooks in code to use as a template and rename it to the same name as your wallpaper file
  4. File names should be all lowercase and separated by - (special characters are allowed)
  5. Download the Level 2 (full scene .tar file) and Level 1 (only band 8 and the MTL.txt files) data for your wallpaper from EarthExplorer
  6. Place the .tar archive in the code folder
  7. Place the band 8 and MTL.txt files in a subfolder of code
  8. Neither of the above should be committed to the repository (there is a .gitignore rule that should prevent this)
  9. Edit the first cell of the notebook to briefly describe your wallpaper
  10. Copy the code to generate the cropped versions of the scene to a new cell and edit it to fit your target area
  11. Ideally, the cropped scene should have at least 1000 pixels in easting in the panchromatic band and be roughly 16:9 in ratio
  12. Edit the cells below to generate a nice looking image
  13. Make sure to set the folder name in data and the prefix for the wallpapers to be the same as the notebook title
  14. When you're satisfied with the wallpaper, make the first cell that crops the original scene into a Markdown cell (for future reference)
  15. Rerun the notebook from top to bottom sequentially (use "Restart and run all cells")
  16. Add a new section to the bottom of the README with your wallpaper (copy an entry and replace the name of your wallpaper)
  17. Make sure you commit: the new data files in data/yourfoldername, the notebook in code, the README.md changes, and the 4k and 720p versions of the wallpapers in wallpapers
  18. Open a pull request and wait for a review