Skip to content

Commit c6461be

Browse files
authored
Add new images for Standard Base Documentation (#463)
* Add new images for Standard Base Documentation
1 parent eb4de65 commit c6461be

File tree

4 files changed

+18
-1
lines changed

4 files changed

+18
-1
lines changed
Loading
Loading
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Credits
2+
3+
The current illustration is a digital remake of this [original visual](/patterns/2-structured/project-setup/assets/base_docs_drawing.png).
4+
If you want to edit this illustration, please request access to this [source document](https://docs.google.com/presentation/d/11JOByEO9QXlRLXX5BIv9rjUzPzCKErZzknD1OLcprQQ/edit?usp=sharing).
5+
6+
The humans in the illustration are [bro](https://storyset.com/illustration/coding/bro) and [pana](https://storyset.com/illustration/high-five/pana) from Storyset.
7+
8+
See:
9+
10+
- [Web illustrations by Storyset](https://storyset.com/web)
11+
- [People illustrations by Storyset](https://storyset.com/people)

patterns/2-structured/project-setup/base-documentation.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ contain:
6161
* A "Who we are" section explaining who the [Trusted Committers](../trusted-committer.md) behind the project are - with an explanation that instead of contacting these people privately the public communication channels above should be used for communication.
6262
* An explanation of what the criteria are for the project to turn contributors into Trusted Committers - if that path exists.
6363

64+
![README.md](../../../assets/img/standard-base-documentation/README-for-users.png)
65+
6466
### CONTRIBUTING.md
6567

6668
If the explanation of the steps to make a contribution are too involved, create
@@ -77,7 +79,7 @@ topics:
7779
* How to submit your modifications back to the project.
7880
* Some information on which turnaround time to expect for modifications made.
7981

80-
![Brief picture of README.md and CONTRIBUTING.md content](./assets/base_docs_drawing.png)
82+
![CONTRIBUTING.md](../../../assets/img/standard-base-documentation/CONTRIBUTING-for-contributors.png)
8183

8284
There are many of good examples for how to write a `README.md` and what kind
8385
of information to include in a `CONTRIBUTING.md` file in various open source projects.
@@ -125,3 +127,7 @@ Provide standard base documentation through a README
125127

126128
* [README-template.md](templates/README-template.md) and
127129
* [CONTRIBUTING-template.md](templates/CONTRIBUTING-template.md)
130+
131+
## Credits
132+
133+
[Web](https://storyset.com/web) and [People](https://storyset.com/people) illustrations by Storyset

0 commit comments

Comments
 (0)