Skip to content

Commit 5df9490

Browse files
Renewed project documentations and assets
The initial content of the renewed project repository `README.md` and `CHANGELOG.md` files now contain the SVG hero and badges provided by the great shields.io (1) project. They make use to the available query parameters to style and customize the badges which come closest to Arctic Ice Studio's design. To render the SVG on GitHub the `sanitize=true` query parameter is used to allow rendering SVG's hosted within the repository and served via the `raw.githubusercontent` subdomain. They provide information about - the latest GitHub release version and changelog - Circle CI build and Codecov status - used style guide versions Additionally the README provides information how to contribute to the project and the CHANGELOG includes a template for future version entries. Further documentations about the design concept, architecture and technologies as well as guides for contributions to develop, run and maintain the project will be documented later on. References: (1) https://shields.io Epic GH-33 Resolves GH-57
1 parent 3f221b6 commit 5df9490

File tree

12 files changed

+46492
-2
lines changed

12 files changed

+46492
-2
lines changed

.gitattributes

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@
1515
# leave all files detected as binary untouched.
1616
* text=auto
1717

18+
# +--------+
19+
# + Assets +
20+
# +--------+
21+
*.ai binary
22+
*.png binary
23+
1824
# +------------+
1925
# + Encryption +
2026
# +------------+

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
; Project: snowsaw
55
; Repository: https://github.com/arcticicestudio/snowsaw
66
; License: MIT
7+
78
package-lock=true
89
save-exact=true

CHANGELOG.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/snowsaw/develop/assets/images/repository-hero.svg?sanitize=true"/></a></p>
2+
3+
<p align="center"><a href="https://github.com/arcticicestudio/snowsaw/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/snowsaw.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a></p>
4+
5+
<p align="center">Changelog for <a href="https://github.com/arcticicestudio/snowsaw" target="_blank">snowsaw</a> — A lightweight, plugin-driven and dynamic <a href="https://wiki.archlinux.org/index.php/Dotfiles" target="_blank">dotfiles</a> bootstrapper.</p>
6+
7+
<!--lint disable no-duplicate-headings-->
8+
9+
# x.y.z
10+
11+
![Release Date: xxxx-xx-xx](https://img.shields.io/static/v1.svg?style=flat-square&label=Release%20Date&message=xxxx-xx-xx&colorA=4c566a&colorB=88c0d0) [![Project Board](https://img.shields.io/static/v1.svg?style=flat-square&label=Project%20Board&message=x.y.z&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/arcticicestudio/snowsaw/projects/0) [![Milestone](https://img.shields.io/static/v1.svg?style=flat-square&label=Milestone&message=x.y.z&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/arcticicestudio/snowsaw/milestone/0)
12+
13+
[Show all commits][gh-compare-tag-vx.y.z_vx.y.z]
14+
15+
## Features
16+
17+
<details>
18+
<summary><strong>HEADLINE</strong> — #ID ⇄ #PR_ID (⊶ COMMIT_SHA256_HASH)</summary>
19+
20+
↠ CONTENT
21+
22+
</details>
23+
24+
---
25+
26+
<!--
27+
+------------------+
28+
+ Formatting Notes +
29+
+------------------+
30+
31+
The `<summary />` tag must be separated with a blank line from the actual item content paragraph,
32+
otherwise Markdown elements are not parsed and rendered!
33+
34+
+------------------+
35+
+ Symbol Reference +
36+
+------------------+
37+
↠ (U+21A0): Start of a log section description
38+
— (U+2014): Separator between a log section title and the metadata
39+
⇄ (U+21C4): Separator between a issue ID and pull request ID in a log metadata
40+
⊶ (U+22B6): Icon prefix for the short commit SHA checksum in a log metadata
41+
⇅ (U+21C5): Icon prefix for the link of the Git commit history comparison on GitHub
42+
-->
43+
44+
<!--lint disable final-definition-->
45+
46+
<!-- Base Links -->
47+
48+
<!-- vx.y.z -->
49+
50+
[gh-compare-tag-vx.y.z_vx.y.z]: https://github.com/arcticicestudio/snowsaw/compare/vx.y.z...vx.y.z

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ As for everything else in the project, the contributions to snowsaw are governed
1010

1111
## Getting Started
1212

13-
snowsaw is an open source project and we love to receive contributions from the community! There are many ways to contribute, from [writing- and improving documentation and tutorials](#documentations), [reporting bugs](#bug-reports), [submitting enhancement suggestions](#enhancement-suggestions) which can be incorporated into this project by [submitting a pull request](#pull-requests).
13+
snowsaw is an open source project and we love to receive contributions from the [community][spectrum-community]! There are many ways to contribute, from [writing- and improving documentation and tutorials](#documentations), [reporting bugs](#bug-reports), [submitting enhancement suggestions](#enhancement-suggestions) which can be incorporated into this project by [submitting a pull request](#pull-requests).
1414

1515
The project development workflow and process uses [GitHub Issues][gh-issues]- and [Pull Requests][gh-pr] management to track issues and pull requests including multiple [issue templates][gh-issues-templates].
1616

@@ -206,5 +206,6 @@ Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os
206206
[react-contrib]: https://facebook.github.io/react/contributing/how-to-contribute.html
207207
[ruby-on-rails-contrib]: http://guides.rubyonrails.org/contributing_to_ruby_on_rails.html
208208
[semver]: https://semver.org
209+
[spectrum-community]: https://spectrum.chat/arcticicestudio/snowsaw
209210
[sscce]: http://sscce.org
210211
[stackoverflow-mcve]: https://stackoverflow.com/help/mcve

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/snowsaw/develop/assets/images/repository-hero.svg?sanitize=true"/></p>
2+
3+
<p align="center"><a href="https://github.com/arcticicestudio/snowsaw/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/snowsaw.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a> <a href="https://github.com/arcticicestudio/snowsaw/blob/develop/CHANGELOG.md" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/snowsaw.svg?style=flat-square&label=Changelog&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a></p>
4+
5+
<p align="center"><a href="https://circleci.com/gh/arcticicestudio/snowsaw" target="_blank"><img src="https://img.shields.io/circleci/project/github/arcticicestudio/snowsaw/develop.svg?style=flat-square&label=Build&logo=circleci&logoColor=eceff4&colorA=4c566a"/></a> <a href="https://codecov.io/gh/arcticicestudio/snowsaw" target="_blank"><img src="https://img.shields.io/codecov/c/github/arcticicestudio/snowsaw/develop.svg?style=flat-square&label=Coverage&logo=codecov&logoColor=eceff4&colorA=4c566a"/></a></p>
6+
7+
<p align="center"><a href="https://github.com/arcticicestudio/styleguide-markdown/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-markdown.svg?style=flat-square&label=Markdown%20Style%20Guide&logoColor=eceff4&colorA=4c566a&colorB=88c0d0&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzOSIgaGVpZ2h0PSIzOSIgdmlld0JveD0iMCAwIDM5IDM5Ij48cGF0aCBmaWxsPSJub25lIiBzdHJva2U9IiNEOERFRTkiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlLW1pdGVybGltaXQ9IjEwIiBkPSJNMS41IDEuNWgzNnYzNmgtMzZ6Ii8%2BPHBhdGggZmlsbD0iI0Q4REVFOSIgZD0iTTIwLjY4MyAyNS42NTVsNS44NzItMTMuNDhoLjU2Nmw1Ljg3MyAxMy40OGgtMS45OTZsLTQuMTU5LTEwLjA1Ni00LjE2MSAxMC4wNTZoLTEuOTk1em0tMi42OTYgMGwtMTMuNDgtNS44NzJ2LS41NjZsMTMuNDgtNS44NzJ2MS45OTVMNy45MzEgMTkuNWwxMC4wNTYgNC4xNnoiLz48L3N2Zz4%3D"/></a> <a href="https://github.com/arcticicestudio/styleguide-git/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-git.svg?style=flat-square&label=Git%20Style%20Guide&logoColor=eceff4&colorA=4c566a&colorB=88c0d0&logo=git"/></a></p>
8+
9+
<p align="center">A lightweight, plugin-driven and dynamic <a href="https://wiki.archlinux.org/index.php/Dotfiles" target="_blank">dotfiles</a> bootstrapper.</p>
10+
11+
## Contributing
12+
13+
snowsaw is an open source project and we love to receive contributions from the [community][spectrum-community]!
14+
15+
There are many ways to contribute, from [writing- and improving documentation and tutorials][snowsaw-contrib-guide-docs], [reporting bugs][snowsaw-contrib-guide-bugs], [submitting enhancement suggestions][snowsaw-contrib-guide-enhance] that can be added to Nord by [submitting pull requests][snowsaw-contrib-guide-pr].
16+
17+
Please take a moment to read Nord's full [contributing guide][snowsaw-contrib-guide] to learn about the development process, the project's used [styleguides][snowsaw-contrib-guide-styles], [branch organization][snowsaw-contrib-guide-branching] and [versioning][snowsaw-contrib-guide-versioning] model.
18+
19+
The guide also includes information about [minimal, complete, and verifiable examples][snowsaw-contrib-guide-mcve] and other ways to contribute to the project like [improving existing issues][snowsaw-contrib-guide-impr-issues] and [giving feedback on issues and pull requests][snowsaw-contrib-guide-feedback].
20+
21+
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p>
22+
23+
<p align="center">Copyright &copy; 2017-present <a href="https://www.arcticicestudio.com" target="_blank">Arctic Ice Studio</a> and <a href="https://www.svengreb.de" target="_blank">Sven Greb</a></p>
24+
25+
<p align="center"><a href="https://github.com/arcticicestudio/snowsaw/blob/develop/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>
26+
27+
[snowsaw-contrib-guide-branching]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#branch-organization
28+
[snowsaw-contrib-guide-bugs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#bug-reports
29+
[snowsaw-contrib-guide-docs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#documentations
30+
[snowsaw-contrib-guide-enhance]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#enhancement-suggestions
31+
[snowsaw-contrib-guide-feedback]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests
32+
[snowsaw-contrib-guide-impr-issues]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#improve-issues
33+
[snowsaw-contrib-guide-mcve]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#mcve
34+
[snowsaw-contrib-guide-pr]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#pull-requests
35+
[snowsaw-contrib-guide-styles]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#styleguides
36+
[snowsaw-contrib-guide-versioning]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#versioning
37+
[snowsaw-contrib-guide]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md
38+
[spectrum-community]: https://spectrum.chat/arcticicestudio/snowsaw

assets/images/gopher-logo.ai

Lines changed: 1920 additions & 0 deletions
Large diffs are not rendered by default.

assets/images/gopher-logo.svg

Lines changed: 38 additions & 0 deletions
Loading

assets/images/logo.ai

Lines changed: 22306 additions & 0 deletions
Large diffs are not rendered by default.

assets/images/logo.svg

Lines changed: 6 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)