Skip to content

Commit b4977e4

Browse files
authored
Update copilot-instructions.md (#16287)
1 parent 3c3382f commit b4977e4

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
If a user commits a new method that is marked [IsVisibleInDynamoLibrary(true)], this indicates the addition of a new node. Another way a user might indicate that they have added a new node is in the commit message. When a new node is added as part of a commit, verify if the appropriate documentation is included. This documentation includes at least 3 files that have the method name in them, but might have additional words. These files are a .dyn, .md, and .jpg. If these files are not part of the commit, alert the user that changes are required and they need to produce this documentation.
1+
# Copilot Chat Instructions for PR Reviews
2+
3+
## Node Addition and Documentation Check
4+
5+
When reviewing a pull request, follow these steps:
6+
7+
1. **Detect New Node Additions**
8+
- If a method is marked with `[IsVisibleInDynamoLibrary(true)]`, or if the commit message or PR description mentions a new node, treat this as a new node addition.
9+
10+
2. **Verify Documentation**
11+
- For each new node, check that the following documentation files are included. Each file should contain the method name (with possible additional words):
12+
- A `.dyn` file (sample graph)
13+
- A `.md` file (markdown documentation)
14+
- A `.jpg` file (visual preview)
15+
- If any of these files are missing, notify the contributor that documentation is incomplete and must be added.
16+
17+
3. **Identify API-Breaking Changes**
18+
- Look for changes that may break the public API, such as:
19+
- Removed or renamed public methods
20+
- Modified method signatures or return types
21+
- If such changes are found, alert the contributor and recommend:
22+
- Updating versioning appropriately
23+
- Documenting the change clearly in the changelog

0 commit comments

Comments
 (0)