Skip to content

Commit bb57099

Browse files
authored
Merge pull request #1528 : document mandatory signed commits
2 parents a0a8922 + 6746d03 commit bb57099

File tree

5 files changed

+22
-0
lines changed

5 files changed

+22
-0
lines changed

.wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ schemas
129129
snapcraft
130130
sudo
131131
Suomi
132+
SHA
132133
SVG
133134
SY
134135
TBC

contributing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ and actually work, you will then get a better response.
1919
* ensure that [unit tests][unit] have been extended or created for any code changes
2020
* if the contribution changes the functionality then ensure that the [functional tests][e2e] are created or modified
2121
* the use of generative AI is not prohibited but must be declared in the [pull request](#use-of-ai-for-coding)
22+
* the main repository only accepts [signed commits][signed-commits], otherwise the contribution will be rejected
2223

2324
### Contributor etiquette
2425

@@ -151,4 +152,5 @@ Threat Dragon: _making threat modeling less threatening_
151152
[project]: https://owasp.org/www-project-threat-dragon/
152153
[raise]: https://github.com/OWASP/threat-dragon/issues/new?assignees=&labels=bug&template=bug_report.md&title=
153154
[request]: https://github.com/OWASP/threat-dragon/issues/new/choose
155+
[signed-commits]: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification
154156
[unit]: https://www.threatdragon.com/docs/testing/unit.html

docs/development/contributing.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ We are trying to keep the test coverage relatively high, so please try to update
1515
There are some [developer notes]({{ '/development/development.html' | relative_url }})
1616
to help you get started with this project.
1717

18+
The Threat Dragon main branch only accepts signed commits, otherwise the contribution will be rejected.
19+
Signed commits help to filter out malicious activity,
20+
see the Github documentation on [commit signature verification][signed-commits].
21+
1822
### Quick start
1923

2024
Clone and install the Threat Dragon repo:
@@ -41,3 +45,5 @@ For secure disclosure, please see the [security policy](https://github.com/OWASP
4145
----
4246

4347
Threat Dragon: _making threat modeling less threatening_
48+
49+
[signed-commits]: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification

docs/development/development.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ for example the dropping of 'unnecessary' semicolons is not to be adopted.
5050

5151
Indents are generally set to 4, but this may change and it might go to a 2 space indentation sometime in the future.
5252

53+
To contribute to the Threat Dragon main branch you must provide signed commits, otherwise they will be rejected.
54+
Signed commits help to filter out malicious activity,
55+
see the Github documentation on [commit signature verification][signed-commits].
56+
5357
### Running Locally
5458

5559
The local environment is split into different parts: `td.server` and `td.vue`.
@@ -112,3 +116,5 @@ The notarization status of the MacOS `.app` file can be checked with command:
112116
----
113117

114118
Threat Dragon: _making threat modeling less threatening_
119+
120+
[signed-commits]: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification

docs/trust/trust.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ group: Trust
88

99
## Trust
1010

11+
The Threat Dragon development team build security into the application and the supply chain.
12+
Some examples of this are:
13+
14+
* the code repository enforces signed commits which helps filter out malicious activity
15+
* the supply chain actions are identified using a full-length SHA
16+
* the desktop installer releases are signed and notarized where possible
17+
1118
### Continual testing
1219

1320
The automated security scans of Threat Dragon are run on every commit:

0 commit comments

Comments
 (0)