Skip to content
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.

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

Renewed project documentations and assets #57

Closed
2 tasks done
arcticicestudio opened this issue Jun 23, 2019 · 1 comment
Closed
2 tasks done

Renewed project documentations and assets #57

arcticicestudio opened this issue Jun 23, 2019 · 1 comment

Comments

@arcticicestudio
Copy link
Owner

arcticicestudio commented Jun 23, 2019

Epic: #33

The initial content of the renewed project repository README.md and CHANGELOG.md files will contain the SVG hero and badges provided by the great shields.io project. They will make use to the available query parameters to style and customize the badges which come closest to Arctic Ice Studio's design.
Additionally the README will provide 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.

Tasks

  • Create project repository hero using GitHub's new sanitize=true query parameter to allow rendering SVG's hosted within the repository and served via the raw.githubusercontent subdomain.
  • Add shields.io badges for
    • latest GitHub release version and changelog
    • Circle CI build and Codecov status
    • used style guide versions
@arcticicestudio arcticicestudio added this to the 0.4.0 milestone Jun 23, 2019
@arcticicestudio arcticicestudio self-assigned this Jun 23, 2019
@arcticicestudio arcticicestudio changed the title Renewed README and Assets Renewed project documentations and assets Jun 23, 2019
arcticicestudio added a commit that referenced this issue Jun 23, 2019
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
@arcticicestudio
Copy link
Owner Author

Resolved in 5df9490

@arcticicestudio arcticicestudio removed their assignment Jun 23, 2019
arcticicestudio added a commit that referenced this issue Jun 24, 2019
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant