Skip to content

Commit 7d4b38b

Browse files
Add PR Template (#1181)
* Add PR Template * cleanup * Spelling
1 parent aa1e9d2 commit 7d4b38b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/pull_request_template.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Description
2+
3+
*Please provide a detailed description. Be as descriptive as possible - include information about what is being changed,
4+
why it's being changed, and any links to relevant issues. If this is closing an existing issue use one of the [issue linking keywords](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to link the issue to this PR and have it automatically close when completed.*
5+
6+
In addition, go through the checklist below and check each item as you validate it is either handled or not applicable to this change.
7+
8+
# Code Changes
9+
10+
- [ ] [Unit tests](https://github.com/Azure/azure-functions-sql-extension/tree/main/test/Unit) are added, if possible
11+
- [ ] [Integration tests](https://github.com/Azure/azure-functions-sql-extension/tree/main/test/Integration) are added if the change is modifying existing behavior of one or more of the bindings
12+
- [ ] New or changed code follows the C# style guidelines defined in .editorconfig
13+
- [ ] All changes MUST be backwards compatible and changes to the shared `az_func.GlobalState` table must be compatible with all prior versions of the extension
14+
- [ ] Use the `ILogger` instance to log relevant information, especially information useful for debugging or troubleshooting
15+
- [ ] Use `async` and `await` for all long-running operations
16+
- [ ] Ensure proper usage and propagation of `CancellationToken`
17+
- [ ] T-SQL is safe from SQL Injection attacks through the use of [SqlParameters](https://learn.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlparameter) and proper escaping/sanitization of input
18+
19+
# Dependencies
20+
21+
- [ ] If updating dependencies, run `dotnet restore --force-evaluate` to update the lock files and ensure that there are NO major versions updates in either [src/packages.lock.json](https://github.com/Azure/azure-functions-sql-extension/blob/main/src/packages.lock.json) or [Worker.Extensions.Sql/src/packages.lock.json](https://github.com/Azure/azure-functions-sql-extension/blob/main/Worker.Extensions.Sql/src/packages.lock.json). If there are, contact the dev team for instructions.
22+
23+
# Documentation
24+
25+
- [ ] Add [samples](https://github.com/Azure/azure-functions-sql-extension/tree/main/samples) if the change is modifying or adding functionality
26+
- [ ] Update relevant documentation in the [docs](https://github.com/Azure/azure-functions-sql-extension/tree/main/docs)

0 commit comments

Comments
 (0)