Commit b7360d44 authored by Nils Windisch's avatar Nils Windisch
Browse files

docs: minor markdown linting

parent 2d50d18b
Pipeline #137089 passed with stages
in 2 minutes and 8 seconds
# Description
# Bug
## Description
Just leave a short summary what the bug is about and where you came to notice it.
## I expected the following to happen:
### I expected the following to happen:
## On the contrary, I observed:
### On the contrary, I observed:
# How to reproduce the bug
## How to reproduce the bug
Please describe briefly how you discovered the bug and what a developer has to do to reproduce it.
......@@ -20,7 +22,7 @@ _Steps:_
* Step 2
* ...
# Severity
## Severity
How much impact does this bug have on the product or further development?
......@@ -29,24 +31,24 @@ How much impact does this bug have on the product or further development?
* [ ] Critical
* [ ] Blocker
# Platform
## Platform
* [ ] Unix
* [ ] Windows
* [ ] MacOS
# Browser
## Browser
* [ ] Safari
* [ ] Chrome/Chromium
* [ ] Firefox
* [ ] Other: ?
# Program and – if applicable – dependency version
## Program and – if applicable – dependency version
Which version of the software did you use?
# Related tickets
## Related tickets
Add related issues (if applicable).
......
# Description
# Feature Requested
## Description
Just leave a short summary what the feature is about.
# Use Cases
## Use Cases
If you can, please provide use cases for this feature.
# Classification
## Classification
Is this feature an enhancement of existing code or a completely new feature?
* [ ] enhancement
* [ ] new feature
* [ ] enhancement
* [ ] new feature
## Related Tickets
# Related Tickets
Add all related issues (if applicable).
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
# Bugfix
Well, it seems that it is impossible to write software without bugs.
That's why we are really happy that you are here.
Thank you very much!
Please take a moment to help us include the purposed bugfix by filling out the following form.
# Summary
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
# Related Tickets
## Related Tickets
Add all related issues and especially those to be closed.
Keep in mind that every bugfix branch needs an issue that properly describes the bug beforehand.
If your fix addresses something untracked, please open a ticket at first.
## Related
### Related
## Closes
### Closes
# Changelog
## Changelog
* [ ] I added a statement to the CHANGELOG.
......
# Feature
We welcome every new feature to the upstream branch!
But at first we ask you to fill in the following information about your feature.
So please take a few minutes to make this great thing even better.
# Summary
## Summary
This MR provides…
# Use Cases
## Use Cases
If you can, please provide use cases for this feature.
# Documentation
## Documentation
Shall we add your feature to the documentation?
......@@ -19,35 +21,35 @@ Shall we add your feature to the documentation?
* [ ] At least I added a headline to the documentation.
* [ ] Not applicable
## Function Documentation
### Function Documentation
* [ ] Of course I prepared all my functions with an appropriate documentation.
## Are There Parts of the Documentation We Have to Adjust?
### Are There Parts of the Documentation We Have to Adjust?
* [ ] No.
* [ ] Yes, but I'd like someone else to do it.
* [ ] Yes, and I already did!
# Tests
## Tests
Are we able to test this new feature?
* [ ] Yes, everything can be done via unit tests.
* [ ] No, it is not possible.
# Changelog
## Changelog
* [ ] I added a statement to the CHANGELOG.
# Related Tickets
## Related Tickets
Add all related issues and especially those to be closed.
## Related
### Related
## Closes
### Closes
# Logs and Screenshots
## Logs and Screenshots
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
......@@ -6,39 +7,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.0.5] - 2020-05-20
### Added
- add a contribution guideline
- added titles in the footer for Language- and Info-icon
### Changed
- make README more comprehensible for outsiders
### Fixed
- icons side by side via css float
## [0.0.4] - 2020-05-19
### Added
- Text can now be zoomed in and out to a max of 32px and min of 8px. The fontsize defaults to 14px. It is tracked during browsing.
- Software info includes links to documentation, source code and bug reporting
## [0.0.3] - 2020-05-18
### Added
- extended config object in index.html by a key named "standalone" (Possible values: true || false).
This indicates if the viewer will be used embedded or standalone respectively.
If used in the latter case, the language toggle shows up in the footer and vice versa.
## [0.0.2] - 2020-05-15
### Added
- openseadragon.vue: Event listener for fullscreen change
### Changed
- toggle fs icon on fullscreen change
## [0.0.1] - 2020-05-14
### Added
- This CHANGELOG file
### Added
- Pages deployment on per commit and per branch base
......@@ -9,7 +9,6 @@ Issues are created and assigned by the project's Product Owner during a sprint p
As soon as you start working on a assigned issue, switch its label to `Doing`.
This will cause the issue to be moved into the right list of the repository's [board](https://gitlab.gwdg.de/subugoe/emo/QViewer/-/boards).
## Internal Workflow
### Reporting Bugs or Change Requests
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment