|
| 1 | +# GitHub Copilot Instructions for sfmc-devtools |
| 2 | + |
| 3 | +Always assume a bug-ticket might be outdated and first try to verify if the described issue is still occurring. |
| 4 | + |
| 5 | +## Commit Messages |
| 6 | + |
| 7 | +Prefix every commit message with the issue number it was created for: |
| 8 | + |
| 9 | +``` |
| 10 | +#1234: <commit message> |
| 11 | +``` |
| 12 | + |
| 13 | +Example: `#1234: fix journey deployment error` |
| 14 | + |
| 15 | +## Branch Naming |
| 16 | + |
| 17 | +Branch names must follow this pattern, where the type is derived from the issue type: |
| 18 | + |
| 19 | +``` |
| 20 | +copilot/task/1234-issue-title |
| 21 | +copilot/bug/1234-issue-title |
| 22 | +copilot/feature/1234-issue-title |
| 23 | +``` |
| 24 | + |
| 25 | +- Use `task` for task/chore issues |
| 26 | +- Use `bug` for bug report issues |
| 27 | +- Use `feature` for feature request/enhancement issues |
| 28 | +- Replace spaces in the issue title with hyphens and use lowercase |
| 29 | + |
| 30 | +## Pull Request Title |
| 31 | + |
| 32 | +The PR title should be derived from the branch name: |
| 33 | + |
| 34 | +``` |
| 35 | +Branch: copilot/task/1234-issue-title |
| 36 | +PR title: task/1234 issue title |
| 37 | +``` |
| 38 | + |
| 39 | +Format: `<type>/<issue-number> <issue title with spaces>` |
| 40 | + |
| 41 | +## Pull Request Description |
| 42 | + |
| 43 | +Follow the structure defined in [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md): |
| 44 | + |
| 45 | +```markdown |
| 46 | +# PR details |
| 47 | + |
| 48 | +## What changes did you make? (Give an overview) |
| 49 | + |
| 50 | +- closes #1234 |
| 51 | + |
| 52 | +## Further details (optional) |
| 53 | + |
| 54 | +... |
| 55 | + |
| 56 | +## Checklist |
| 57 | + |
| 58 | +- [ ] I have performed a self-review of my own code |
| 59 | +- [ ] I have commented my code, particularly in hard-to-understand areas |
| 60 | +- [ ] test scripts updated |
| 61 | +- [ ] Wiki updated (if applicable) |
| 62 | +``` |
| 63 | + |
| 64 | +Replace `#1234` with the actual issue number the PR is created for. |
| 65 | + |
| 66 | +## Issue Relationship |
| 67 | + |
| 68 | +Always link the PR to the issue it was created for by including `closes #<issue-number>` in the PR description. |
| 69 | + |
| 70 | +## Labels |
| 71 | + |
| 72 | +The repository has component labels prefixed with `c/` based on the class names in `lib/metadataTypes/`. When files in that directory are changed, assign the matching pre-existing `c/` label(s) to the PR. |
| 73 | + |
| 74 | +Examples: |
| 75 | +- Changes to `lib/metadataTypes/Journey.js` → assign label `c/journey` |
| 76 | +- Changes to `lib/metadataTypes/Automation.js` → assign label `c/automation` |
| 77 | +- Changes to `lib/metadataTypes/DataExtension.js` → assign label `c/dataextension` |
| 78 | + |
| 79 | +The label name is `c/` followed by the lower camel-cased class name (filename without extension). |
| 80 | + |
| 81 | +Only assign labels that already exist in the repository. |
| 82 | + |
| 83 | +## Milestone |
| 84 | + |
| 85 | +Assign the same milestone to the PR that the issue has assigned. |
0 commit comments