Commit c3f87d0d authored by mrodzis's avatar mrodzis 🌿
Browse files

Merge branch 'feature/#18-contributing' into 'develop'

Feature/#18 contributing

See merge request subugoe/emo/Qviewer!9
parents 5f0589e2 aa335a9c
Pipeline #137112 passed with stages
in 2 minutes and 7 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.
_Steps:_
* Step 1
* Step 2
* ...
# Severity
* Step 1
* Step 2
* ...
## Severity
How much impact does this bug have on the product or further development?
* [ ] Minor
* [ ] Major
* [ ] Critical
* [ ] Blocker
# Platform
* [ ] Unix
* [ ] Windows
* [ ] MacOS
# Browser
* [ ] Safari
* [ ] Chrome/Chromium
* [ ] Firefox
* [ ] Other: ?
# Program and – if applicable – dependency version
* [ ] Minor
* [ ] Major
* [ ] Critical
* [ ] Blocker
## Platform
* [ ] Unix
* [ ] Windows
* [ ] MacOS
## Browser
* [ ] Safari
* [ ] Chrome/Chromium
* [ ] Firefox
* [ ] Other: ?
## Program and – if applicable – dependency version
Which version of the software did you use?
# Related Tickets
Add related issues if applicable.
## Related tickets
Add related issues (if applicable).
/cc @mgoebel, @schneider210
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
# 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.
Add all related issues (if applicable).
/cc @mgoebel, @schneider210
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
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.
# Bugfix
# 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.
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.
## Related
## Closes
## 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.
# Changelog
## 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
### Closes
## Changelog
* [ ] I added a statement to the CHANGELOG.
/cc @schneider210 @mgoebel
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
# 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?
* [ ] I've already did it!
* [ ] 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
## Closes
### Related
### Closes
# Logs and Screenshots
## Logs and Screenshots
/cc @schneider210 @mgoebel
/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,34 +7,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.0.6] - 2020-05-20
## [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
# How To Contribute
The following is a set of guidelines for contributing to the EMo Viewer.
Feel free to propose changes whenever the workflow could be improved!
## Issue Tracker
Issues are created and assigned by the project's Product Owner during a sprint planning in the [issue tracker](https://gitlab.gwdg.de/subugoe/emo/QViewer/-/issues).
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
Bugs and change requests are managed by the project's Product Owner.
Please report any problems that aren't related to the bugfix/feature you're working on right now to her/him.
Bug reports can also be handed it via [mail](mailto:gitlab+subugoe-emo-qviewer-10921-issue-@gwdg.de).
She/he will create an issue in the correct repository and ask for assignees in the course of the next sprint planning.
### Git Flow
For developing in EMo we use `git flow` as a branching and development model.
This means that all development will be reviewed before they will be merged to the `develop` branch.
Please confer [Atlassian's git flow tutorial](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for more information on how git flow works.
Every branch should be to dedicated to an issue, i.e. there shouldn't be any branches without a corresponding ticket.
Each branch should start with the dedicated issue number and a short description on what the ticket is about, e.g. `feature/#1-contributing`.
All issues will be arranged in [milestones](https://gitlab.gwdg.de/groups/subugoe/ahiqar/-/milestones).
Milestones are always group-wide, so we combine tickets from all repositories associated with Ahiqar to a single milestone.
The milestone number is increased with each sprint in accordance to [Semantic Versioning](https://semver.org/).
### Merge Requests (MR)
Merge requests should be peer reviewed before merging them into `develop`.
A well-tried workflow is:
1. A developer decides to work on a feature.
She uses the current development branch as a base for her work.
She commits her changes to a separate feature branch.
After some time she finishes the feature and wants it to be part of the development branch.
2. Before creating her merge request, the developer rebases her branch on the basis of `develop`.
This minimizes the change of merge conflicts.
You can either use `rebase` or `merge` for this.
3. The developer creates a merge request and assigns everybody she sees fit to properly review her code to it.
She uses one of the proposed merge templates in order to not forget anything and ease her reviewers' work.
4. To avoid diffusion of responsibility, she also assigns one of the chosen assignees as MUST.
This means that this person has to approve the MR, otherwise the merge cannot be done.
Although GitLab sends notifications to everybody who is newly assigned to a MR, she should notify the MUST assignee personally (in case he or she doesn't notice the mail sent by GitLab).
The MR settings are:
* The MR is associated with the current sprint's [milestone](https://gitlab.gwdg.de/groups/subugoe/ahiqar/-/milestones).
* The boxes for "Squash Commit" and "Deleting branch after Merge" are ticked
5. The MUST assignee reviews the changes according to style, variable naming, understandability, documentation provided, functionality, etc.
If everything is to his or her liking, he or she approves the MR.
The other assignees are free to review the code as well.
**Note:** MRs without docs should not be accepted.
6. After the MR has been (dis)approved, the assignee removes his- or herself from the list of assignees.
The MUST assignee informs the developer over the review being done.
7. The developer merges her changes into the development branch.
If a merge conflict occurs the person who has proposed the MR is responsible for solving all conflicts.
# Emo Viewer (viewer)
# EMo Viewer
Viewer for the modular framework to present digital editions.
**Note:**
Although the EMo Viewer is designed as a generic viewer for digital editions, it is currently developed within the scope of the [Ahiqar project](https://gitlab.gwdg.de/subugoe/ahiqar).
This is the reason for "Ahiqar" being mentioned several times in the docs of this repo.
Demo: https://subugoe.pages.gwdg.de/emo/Qviewer/develop
(for newer branches the demo is deployed in a directory named with branch name lowercased, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-` (CI_COMMIT_REF_SLUG). Also the commit short hash can be used to see a demo.
(For newer branches the demo is deployed in a directory named with branch name lowercased, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-` (CI_COMMIT_REF_SLUG).
Also the commit short hash can be used to see a demo.
## Getting Started
......@@ -17,6 +22,7 @@ To get the EMo Viewer up and running you should have the following software inst
* vue-cli-service-global (globally installed)
For using the development mode you also need
* quasar-cli (globally installed)
To get all dependencies via `npm`, simply run
......@@ -38,7 +44,7 @@ npm install
```bash
quasar dev
```
### Lint the files
```bash
......@@ -55,14 +61,17 @@ quasar build
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
## Authors
See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
Please notice our [contribution guidelines](CONTRIBUTING.md) which contains all necessary information about the development workflow.
## Dockerfile
The dockerfile is used at GitLab CI. It needs to be updated, when either node or quasar-cli should be updated.
```
docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node .
The dockerfile is used at GitLab CI.
It needs to be updated, when either node or quasar-cli should be updated.
```bash
docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node .
docker push docker.gitlab.gwdg.de/subugoe/emo/qviewer/node
```
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