Skip to content

Commit

Permalink
Renewed project documentations and assets
Browse files Browse the repository at this point in the history
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
  • Loading branch information
arcticicestudio committed Jun 24, 2019
1 parent 3f221b6 commit daf93dd
Show file tree
Hide file tree
Showing 12 changed files with 46,492 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@
# leave all files detected as binary untouched.
* text=auto

# +--------+
# + Assets +
# +--------+
*.ai binary
*.png binary

# +------------+
# + Encryption +
# +------------+
Expand Down
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
; Project: snowsaw
; Repository: https://github.com/arcticicestudio/snowsaw
; License: MIT

package-lock=true
save-exact=true
50 changes: 50 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/snowsaw/develop/assets/images/repository-hero.svg?sanitize=true"/></a></p>

<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>

<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>

<!--lint disable no-duplicate-headings-->

# x.y.z

![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)

[Show all commits][gh-compare-tag-vx.y.z_vx.y.z]

## Features

<details>
<summary><strong>HEADLINE</strong> — #ID ⇄ #PR_ID (⊶ COMMIT_SHA256_HASH)</summary>

↠ CONTENT

</details>

---

<!--
+------------------+
+ Formatting Notes +
+------------------+
The `<summary />` tag must be separated with a blank line from the actual item content paragraph,
otherwise Markdown elements are not parsed and rendered!
+------------------+
+ Symbol Reference +
+------------------+
↠ (U+21A0): Start of a log section description
— (U+2014): Separator between a log section title and the metadata
⇄ (U+21C4): Separator between a issue ID and pull request ID in a log metadata
⊶ (U+22B6): Icon prefix for the short commit SHA checksum in a log metadata
⇅ (U+21C5): Icon prefix for the link of the Git commit history comparison on GitHub
-->

<!--lint disable final-definition-->

<!-- Base Links -->

<!-- vx.y.z -->

[gh-compare-tag-vx.y.z_vx.y.z]: https://github.com/arcticicestudio/snowsaw/compare/vx.y.z...vx.y.z
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ As for everything else in the project, the contributions to snowsaw are governed

## Getting Started

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).
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).

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].

Expand Down Expand Up @@ -206,5 +206,6 @@ Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os
[react-contrib]: https://facebook.github.io/react/contributing/how-to-contribute.html
[ruby-on-rails-contrib]: http://guides.rubyonrails.org/contributing_to_ruby_on_rails.html
[semver]: https://semver.org
[spectrum-community]: https://spectrum.chat/arcticicestudio/snowsaw
[sscce]: http://sscce.org
[stackoverflow-mcve]: https://stackoverflow.com/help/mcve
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/snowsaw/develop/assets/images/repository-hero.svg?sanitize=true"/></p>

<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>

<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>

<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>

<p align="center">A lightweight, plugin-driven and dynamic <a href="https://wiki.archlinux.org/index.php/Dotfiles" target="_blank">dotfiles</a> bootstrapper.</p>

## Contributing

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][snowsaw-contrib-guide-docs], [reporting bugs][snowsaw-contrib-guide-bugs], [submitting enhancement suggestions][snowsaw-contrib-guide-enhance] that can be added to snowsaw by [submitting pull requests][snowsaw-contrib-guide-pr].

Please take a moment to read snowsaw'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.

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].

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p>

<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>

<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>

[snowsaw-contrib-guide-branching]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#branch-organization
[snowsaw-contrib-guide-bugs]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#bug-reports
[snowsaw-contrib-guide-docs]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#documentations
[snowsaw-contrib-guide-enhance]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#enhancement-suggestions
[snowsaw-contrib-guide-feedback]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests
[snowsaw-contrib-guide-impr-issues]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#improve-issues
[snowsaw-contrib-guide-mcve]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#mcve
[snowsaw-contrib-guide-pr]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#pull-requests
[snowsaw-contrib-guide-styles]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#styleguides
[snowsaw-contrib-guide-versioning]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#versioning
[snowsaw-contrib-guide]: https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md
[spectrum-community]: https://spectrum.chat/arcticicestudio/snowsaw
1,920 changes: 1,920 additions & 0 deletions assets/images/gopher-logo.ai

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions assets/images/gopher-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22,306 changes: 22,306 additions & 0 deletions assets/images/logo.ai

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions assets/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit daf93dd

Please sign in to comment.