aboutsummaryrefslogtreecommitdiff
path: root/.github/DOCS.md
diff options
context:
space:
mode:
authorFelipe Balbi <[email protected]>2025-11-07 10:43:32 -0800
committerFelipe Balbi <[email protected]>2025-11-07 10:51:04 -0800
commit812f3c840f4d505e285d1ddce6b0981dd745e344 (patch)
tree4425cdc41b4dd59c5e8dbbfdef3b8e10cad28063 /.github/DOCS.md
parente75066820ad320495ca70570641c90d75247b19b (diff)
Reintroduce necessary files
Signed-off-by: Felipe Balbi <[email protected]>
Diffstat (limited to '.github/DOCS.md')
-rw-r--r--.github/DOCS.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/.github/DOCS.md b/.github/DOCS.md
new file mode 100644
index 000000000..e932784c7
--- /dev/null
+++ b/.github/DOCS.md
@@ -0,0 +1,23 @@
1# Github config and workflows
2
3In this folder there is configuration for codecoverage, dependabot, and ci
4workflows that check the library more deeply than the default configurations.
5
6This folder can be or was merged using a --allow-unrelated-histories merge
7strategy from <https://github.com/jonhoo/rust-ci-conf/> which provides a
8reasonably sensible base for writing your own ci on. By using this strategy
9the history of the CI repo is included in your repo, and future updates to
10the CI can be merged later.
11
12To perform this merge run:
13
14```shell
15git remote add ci https://github.com/jonhoo/rust-ci-conf.git
16git fetch ci
17git merge --allow-unrelated-histories ci/main
18```
19
20An overview of the files in this project is available at:
21<https://www.youtube.com/watch?v=xUH-4y92jPg&t=491s>, which contains some
22rationale for decisions and runs through an example of solving minimal version
23and OpenSSL issues.