luciano/d2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #568 from ejulio-ts/update-contributing

Browse source 
Update CONTRIBUTING
This commit is contained in:
Alexander Wang 2022-12-30 10:10:17 -08:00 committed by GitHub
commit 1e445b589a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
ci/sub

@ -1 +1 @@
Subproject commit b1ec0a8d430a62b7556211ed8bcd7b6e41e2362c Subproject commit 9a29d9ea640834905c4010c0b3d14b7301ebb6d8

14
docs/CONTRIBUTING.md
View file

@ -17,6 +17,20 @@ Most of D2's CI is open sourced in its own
workflows. E.g. run `./make.sh fmt` to run the formatter. Please make sure all CI is workflows. E.g. run `./make.sh fmt` to run the formatter. Please make sure all CI is
passing for any PRs. passing for any PRs.
Most of the CI scripts rely on a submodule shared between many D2 repositories:
[https://github.com/terrastruct/ci](https://github.com/terrastruct/ci). You should fetch
the submodule whenever it differs:
```sh
git submodule update --recursive
```
If running for the first time for a repo (e.g. new clone), add `--init`:
```sh
git submodule update --init --recursive
```
## Flow ## Flow
The simplified D2 flow at a package level looks like: The simplified D2 flow at a package level looks like: