Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 16 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

<!--
What existing issue does the pull request solve?
Please provide enough information so that others can review your pull request
If this closes an existing issue then add "closes #xxxx", where xxxx is the issue number
Add "closes #xxxx", where xxxx is the issue number
You must have been assigned the issue before submitting the pull request
and provide enough information so that others can review your changes
-->

**Description for the changelog**:

<!-- A short (one line) summary that describes the changes in this pull request for inclusion in the change log -->
<!--
A short (one line) summary that describes the changes in this pull request
for inclusion in the change log
-->

**Declaration**:

Expand All @@ -18,8 +22,15 @@ Thanks for submitting a pull request, please make sure:
- [ ] appropriate unit tests have been created and/or modified
- [ ] you have considered any changes required for the functional tests
- [ ] you have read the [contribution guide](../blob/main/contributing.md) and agree to the [Code of Conduct](../blob/main/code_of_conduct.md)
- [ ] you have declared whether any [use of AI](../blob/main/contributing.md#use-of-ai) has (or has not) been used in this pull request
- [ ] *either* no AI-generated content has been used in this pull request
- [ ] *or* any [use of AI](../blob/main/contributing.md#use-of-ai) in this pull request has been disclosed below:
- AI Tools: `[e.g. GitHub CoPilot, ChatGPT, JetBrains Junie, etc]`
- LLMs and versions: `[e.g. GPT-4.1, Claude Haiku 4.5, Gemini 2.5 Pro, etc]`
- Prompts: `[Summarize the key prompts or instructions given to the AI tools]`

**Other info**:

<!-- Add here any other information that may be of help to the reviewer -->
<!--
Add here any other information that may be of help to the reviewer
Automated tests are run which must pass before the pull request can be merged
-->
3 changes: 3 additions & 0 deletions .github/workflows/.trivyignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ CVE-2025-64756

# ignore until Vue2 to Vue3 upgrade
CVE-2025-15284

# ignore diff vulnerability as used in development package only
GHSA-73rr-hh4g-fpgx
2 changes: 1 addition & 1 deletion ThreatDragonModels/v2-threat-model.json
Original file line number Diff line number Diff line change
Expand Up @@ -1114,7 +1114,7 @@
"id": 0
}
],
"diagramTop": 0,
"diagramTop": 1,
"reviewer": "Jane Smith",
"threatTop": 50
},
Expand Down
17 changes: 15 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ and actually work, you will then get a better response.
* if the contribution changes the functionality then ensure that the [functional tests][e2e] are created or modified
* the use of generative AI is not prohibited but must be declared in the [pull request](#use-of-ai-for-coding)

### Contributor etiquette

Github issues are used to coordinate contributions and keep track of progress towards each milestone:

* select an issue from the project board for the section you want to work on
* if this issue is free ask for it to be assigned to you
* if the issue has already been assigned then coordinate with the existing owner
* if there is not an existing issue that describes your content then [suggest one][issues]
* provide your contributed content as a [pull request][request]
* you **must** be assigned the issue before submitting a pull request

## Got a Question or Problem?

If you have a question or problem relating to using Threat Dragon then the first thing to do is to check the
Expand Down Expand Up @@ -66,14 +77,16 @@ The best chance of success for a pull request to be reviewed and accepted:

1. make sure there is an existing issue that the pull request is solving / fixing
2. request that you are assigned this issue first
3. Once the pull request is ready, provide a short but informative title
3. once the pull request is ready, provide a short but informative title
4. provide enough description to explain how Threat Dragon worked before and works after the change
5. extend the unit tests and functional tests to show the change working as expected
6. the pull request must provide one change only, if there are further changes use further pull requests
7. avoid coding using [generative AI](#use-of-ai-for-coding);
if you must then understand fully the changes and keep sprawl to a minimum

We appreciate contributions always, but make sure you have been **assigned the issue** before you submit any pull request.
We appreciate contributions always,
but make sure you have been **assigned the issue** before you submit any pull request
otherwise the pull request is very likely to be discarded.

Note that you **must** follow the rules for any [use of AI](#use-of-ai-for-issues) in the pull request.
This includes using the pull request template provided, otherwise the contribution will be regarded as AI-slop and discarded.
Expand Down
Loading
Loading