Skip to content

Add new images for Standard Base Documentation #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 30, 2022
Merged

Add new images for Standard Base Documentation #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c11b9f4
Add new images for Standard Base Documentation
spier Sep 30, 2022
13092b5
Push fixes
spier Sep 30, 2022
3e325fd
Change background. Add more docs.
spier Sep 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/img/standard-base-documentation/CONTRIBUTING-for-contributors.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/standard-base-documentation/README-for-users.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions assets/img/standard-base-documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Credits

The current illustration is a digital remake of this [original visual](/patterns/2-structured/project-setup/assets/base_docs_drawing.png).
If you want to edit this illustration, please request access to this [source document](https://docs.google.com/presentation/d/11JOByEO9QXlRLXX5BIv9rjUzPzCKErZzknD1OLcprQQ/edit?usp=sharing).

The humans in the illustration are [bro](https://storyset.com/illustration/coding/bro) and [pana](https://storyset.com/illustration/high-five/pana) from Storyset.

See:

- [Web illustrations by Storyset](https://storyset.com/web)
- [People illustrations by Storyset](https://storyset.com/people)
8 changes: 7 additions & 1 deletion patterns/2-structured/project-setup/base-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ contain:
* 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.
* An explanation of what the criteria are for the project to turn contributors into Trusted Committers - if that path exists.

![README.md](../../../assets/img/standard-base-documentation/README-for-users.png)

### CONTRIBUTING.md

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

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

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

* [README-template.md](templates/README-template.md) and
* [CONTRIBUTING-template.md](templates/CONTRIBUTING-template.md)

## Credits

[Web](https://storyset.com/web) and [People](https://storyset.com/people) illustrations by Storyset