NISAR Cookbook Contributor’s Guide

We welcome contributions of all kinds! If you spot a bug, please raise an issue here. We encourage Pull Requests to address bugs or add new features and data recipes.

Please read our Code of Conduct before contributing.

This project uses the standard fork → branch → pull request workflow.

1. View current issues and engage in discussions¶

See if the bug or feature you plan to work on is already under discussion or. If it’s not, start a discussion by raising an issue.

2. Fork the repository¶

Click the Fork button at the top-right of the NISAR_Cookbook GitHub page to create your own copy of the repo.

3. Clone your fork¶

git clone https://github.com/<your-username>/NISAR_Cookbook.git
cd NISAR_Cookbook

4. Create a feature branch¶

git checkout -b feature/my-change

5. Add the upstream remote¶

This lets you pull updates from the main project.

git remote add upstream https://github.com/ASFOpenSARlab/NISAR_Cookbook.git
git remote -v

6. Add new utility scripts (as necessary)¶

Add new utility scripts to the util directory. Favor descriptive filenames (avoid util.py).

7. Add new images to render in notebooks or Markdown documents (as necessary)¶

Add new images to the assets directory.

8. Add new Notebooks or Markdown¶

Add new notebooks and Markdown docs to the notebooks directory

To maintain a consistent format for the Jupyter Book, we have provided a Notebook template that we encourage you to use a starting point.

9. Add any new dependencies to a new or existing Pixi environment¶

If you add dependencies, you will need to add them to an existing or new Pixi environment.

Adds steps to install any new enviornments to the software environment installation notebook.

10. Add and commit your changes¶

Commit in small, focused steps.

git add path/to/file1 path/to/file2
git commit -m "Describe your change"

11. Keep your branch up to date with the upstream cookbook¶

git fetch upstream
git merge upstream/main
# or
git rebase upstream/main

12. Push your branch¶

git push origin feature/my-change

13. Open a Pull Request¶

Go to your fork on GitHub and click Compare & pull request.

Please include a detailed description of your updates and the motivation behind them.