Skip to content

Update CONTRIBUTING.md #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 24, 2025
Merged

Update CONTRIBUTING.md #541

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e48881
Update CONTRIBUTING.md
bachuv Apr 8, 2025
1db73d0
Update CONTRIBUTING.md
bachuv Apr 24, 2025
5862d58
Merge branch 'dev' into vabachu/update-contributing
bachuv Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,30 @@ pip install -e $REPOSITORY_ROOT/
```
where REPOSITORY_ROOT is the root folder of the azure-functions-durable-python repository

7. Set breakpoints and click Run -> Start Debugging in VS Code. This should internally start the Azure Function using `func host start` command.
7. Set breakpoints and click Run -> Start Debugging in VS Code. This should internally start the Azure Function using `func host start` command. If the breakpoints are not getting hit, check to make sure that you have set `justMyCode: false` in the function app's .vscode/launch.json.

```
{
"version": "0.2.0",
"configurations": [
{
...
"justMyCode": false
...
}
]
}
```

### Debugging end-to-end

If you want to debug into the Durable Task or any of the .NET bits, follow instructions below:

1. Open the Azure Storage Explorer and connect to the local storage emulator or the storage account you are using.
2. Make sure the Durable Python debugging is setup already and the debugger has started the `func` process.
3. In the VSCode editor for DurableTask, click Debug -> .NET Core Attach Process and search for `func host start` process and attach to it.
4. Add a breakpoint in both editors and continue debugging.
1. If you would like to debug a custom local WebJobs extension package then create the custom package, place it in a local directory, and then run `func extensions install --package Microsoft.Azure.WebJobs.Extensions.DurableTask --version <VERSION>`. If you update the version while debugging and the new version doesn't get picked up, then try running `func extensions install` to get the new changes.
2. Open the Azure Storage Explorer and connect to the local storage emulator or the storage account you are using.
3. Make sure the Durable Python debugging is setup already and the debugger has started the `func` process.
4. In the VSCode editor for DurableTask, click Debug -> .NET Core Attach Process, search for `func host start` process and attach to it. If you are using Visual Studio, click Debug -> Attach to Process, search for the `func` process and attach to it.
5. Add a breakpoint in both editors and continue debugging.

## Testing changes locally (Windows)

Expand Down