Thank you for your interest in contributing!
Before submitting a new GitHub issue, please make sure to check the existing GitHub issues. If this doesn't help, please submit an issue on GitHub and provide detailed information.
The repository is currently updated and maintained internally at HPI. We currently do not have a procedure for the realization of external contributions.
The video player is build with Stencil. A good way to start is to read the official introduction to Stencil. After this, you should be able to dive into the codebase easier.
If you are working in the HPI team, please make sure to include the ticket number in the commit message.
Please make pull requests to the dev branch.
Add a title and a description. In the description, illustrate first what your code will change. Please add a section on decisions and choices you made next. This is very useful for reviewers to quickly get an overview and understand what the PR is about.
You should include a commit in your PR with the package.json and package-lock.json update.
To define the release type and number, please refer to the semantic versioning documentation.
We follow the proposed guideline by Stencil. The repo has a pre-push git hook with eslint so that new linter offenses do not end up in the code base.