Common documentation and files across my projects

feat!: reorganize repo & documents

Signed-off-by: MatrixFurry <did:plc:zmjoeu3stwcn44647rhxa44o>

matrixfurry.com f60aa7ae e727f902

verified
CODE_OF_CONDUCT.md docs/code_of_conduct.md
+3 -3
CONTRIBUTING.md docs/contributing.md
··· 3 Development happens on [Tangled](https://tangled.org/did:plc:zmjoeu3stwcn44647rhxa44o). 4 5 # Developer Certificate of Origin 6 - By submitting code contributions as an individual or on behalf of a corporation to any directory in this repository, you agree to the [Developer Certificate of Origin](./DCO.txt) 7 8 # Reporting issues 9 Yes, issues are contributions. ··· 33 34 Commit signing is optional but highly recommended. Once you make your first signed commit, all future commits must be signed. 35 36 - Please see the [security policy](./SECURITY.md) for more information. 37 38 ## Submitting changes 39 <!--TODO: Provide more documentation on how pull requests work on Tangled--> ··· 62 If you are unsure, or you had help from automated AI-generation in part of your contribution, please tell us when contributing. It does not mean the contribution will be rejected outright. We will evaluate on a case-by-case basis. We value honesty, and take it into consideration. 63 64 # Security 65 - Please see the [security policy](./SECURITY.md) 66 67 # Maintainers 68
··· 3 Development happens on [Tangled](https://tangled.org/did:plc:zmjoeu3stwcn44647rhxa44o). 4 5 # Developer Certificate of Origin 6 + By submitting code contributions as an individual or on behalf of a corporation to any directory in this repository, you agree to the [Developer Certificate of Origin](./legal/DCO.txt) 7 8 # Reporting issues 9 Yes, issues are contributions. ··· 33 34 Commit signing is optional but highly recommended. Once you make your first signed commit, all future commits must be signed. 35 36 + Please see the [security policy](./security.md) for more information. 37 38 ## Submitting changes 39 <!--TODO: Provide more documentation on how pull requests work on Tangled--> ··· 62 If you are unsure, or you had help from automated AI-generation in part of your contribution, please tell us when contributing. It does not mean the contribution will be rejected outright. We will evaluate on a case-by-case basis. We value honesty, and take it into consideration. 63 64 # Security 65 + Please see the [security policy](./security.md) 66 67 # Maintainers 68
DCO.txt docs/legal/DCO.txt
+1 -1
SECURITY.md docs/security.md
··· 1 - For the most up-to-date security policy, please see [matrixfurry.com/common](https://tangled.org/@matrixfurry.com/common/blob/main/SECURITY.md). 2 3 # Reporting 4 Please report security issues via [SimpleX](https://smp18.simplex.im/a#Wc2x2IBqqwzgmeGkN0XtKrGMLBxFuxmoYgkTGgGgR0M) or [Email](mailto:shiloh@shilohfen.com).
··· 1 + For the most up-to-date security policy, please see [matrixfurry.com/common](https://tangled.org/@matrixfurry.com/common/blob/main/docs/security.md). 2 3 # Reporting 4 Please report security issues via [SimpleX](https://smp18.simplex.im/a#Wc2x2IBqqwzgmeGkN0XtKrGMLBxFuxmoYgkTGgGgR0M) or [Email](mailto:shiloh@shilohfen.com).
+31
meta/scripts/update-common-files.nu
···
··· 1 + #!/usr/bin/env nu 2 + # SPDX-License-Identifier: AGPL-3.0-only 3 + # SPDX-FileCopyrightText: 2025 @matrixfurry.com <did:plc:zmjoeu3stwcn44647rhxa44o> 4 + 5 + use std log 6 + 7 + const common = path self ../../ 8 + 9 + def main [ 10 + --update-license 11 + --commit (-c) 12 + ] { 13 + if $commit and (jj status | lines | first) != "The working copy has no changes." { 14 + error make { 15 + msg: "the working copy has changes" 16 + help: "create an empty commit before updating files" 17 + } 18 + } 19 + 20 + cp -r ($common | path join docs) . 21 + log info "updated common project files" 22 + 23 + if $update_license or not ("./LICENSE" | path exists) { 24 + cp -r ($common | path join LICENSE) . 25 + log warning "updated project license" 26 + } 27 + 28 + if $commit { 29 + jj commit -m "docs: update shared documentation" 30 + } 31 + }
-25
scripts/update-common-files.nu
··· 1 - #!/usr/bin/env nu 2 - # SPDX-License-Identifier: AGPL-3.0-only 3 - # SPDX-FileCopyrightText: 2025 @matrixfurry.com <did:plc:zmjoeu3stwcn44647rhxa44o> 4 - 5 - use std log 6 - 7 - # Update the common files in this directory to the latest from https://tangled.org/@matrixfurry.com/common 8 - def main [] { 9 - let files = [ 10 - "CODE_OF_CONDUCT.md" 11 - "CONTRIBUTING.md" 12 - "DCO.txt" 13 - "SECURITY.md" 14 - ] 15 - 16 - $files 17 - | each {|file| 18 - log info $"Updating file: ($file)" 19 - 20 - http get $"https://tangled.org/@matrixfurry.com/common/raw/main/($file)" 21 - | save -fp $file 22 - } 23 - 24 - null 25 - }
···