Skip to content

Commit

Permalink
[PROPOSAL] PR template for dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
chfsx committed Nov 25, 2024
1 parent bfd09b6 commit 832cb40
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/dependency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
> [!IMPORTANT]
> Please make sure you replace all the {{PLACEHOLDER}} in this template with
> the correct information and remove this disclaimer before submitting your
> pull request.
> Title of the PR should be: "Add `{{NAME}}` as dependency" and must be labeled
> with "dependencies`.
Assessment:
<!-- Given all facts and considerations, describe why this is a dependency
that should be included into ILIAS. -->

General Information:
- Name of the dependency: `{{NAME}}`
- Version: `{{VERSION}}`
- [ ] this dependency was already used in ILIAS.
- [ ] the dependency's license is compatible with ILIAS' license.

Type of dependency:
- [ ] composer
- [ ] npm

Usage:
<!-- Describe how the dependency is used in ILIAS by listing FQDN of
components or even classes.-->
* `components/ILIAS/XYZ/`

Reasoning:
<!-- Explain why this dependency is needed and why it is the best choice. -->
*
*
*

Maintenance:
<!-- Describe the maintenance status of the dependency. Facts like the
amount of maintainers, activity in the repository and other information
could be relevant. We'd like to avoid 'dead' dependecies. -->
*
*
*

Links:
* Packagist/NPM: {{URL}}
* GitHub: {{URL}}
* Documentation: {{URL}}

Alternatives:
<!-- List alternatives to the dependency if possible and explain why they were
not chosen. -->
*

0 comments on commit 832cb40

Please sign in to comment.