Skip to content

Commit

Permalink
docs: add merge requests templates (et/somenergia-jardiner!21)
Browse files Browse the repository at this point in the history
* new: add MR and issue templates

* wip: first versions of templates

Co-authored-by: Lucía García Durañona <[email protected]>
Co-authored-by: Pol Monsó Purtí <[email protected]>
  • Loading branch information
3 people committed Nov 1, 2023
1 parent 7491a1b commit ca8b51c
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .gitlab/issue_templates/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Issue

## This is a

- [ ] Bug
- [ ] Feature Request
- [ ] Documentation update
- [ ] Other (please specify)

## Description

A clear and concise description

## How to Reproduce

Steps to reproduce the behavior. For example:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error `Error: '...'`

## Expected behavior

A clear and concise description of what you expected to happen.

## Screenshots

If applicable, add screenshots to help explain your problem.

## Additional context

Add any other context about the problem here.

## Possible Solution

If you have a possible solution, please describe it here.

## Related Issues and other links

Provide links to the related issues or feature requests, or any other link that could be useful to understand the context of the issue.
51 changes: 51 additions & 0 deletions .gitlab/merge_request_templates/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# New merge request

## Description

This merge request addresses, and describe the problem or user story being addressed.

## Related Issues

Provide links to the related issues or feature requests.

## Related links

- Any link to trello, helpscout, etc. That could be useful to understand the context of the MR.

## General checklist

- [ ] I have run pre-commit hooks locally and fixed any issues.
- [ ] I have removed any commented out code.
- [ ] I have removed any TODO comments and added an issue for each one of them.
- [ ] I have added tests to cover the changes.
- [ ] I have added documentation to cover the changes.

## dbt checklist

- [ ] This MR includes changes to the dbt models in the project
- [ ] All models in this MR [follow naming schemes](outline.somenergia.coop)
- [ ] All models in this MR have a valid `_<scope>__models.yml` file
- [ ] All models in this MR have a description and are documented, to some extent, throught the `_<scope>__models.yml` file
- [ ] All models in this MR have valid tags
- [ ] All models in this MR have a valid `_<scope>__sources.yml` file
- [ ] All models are formatted using the [`henriblancke.vscode-dbt-formatter`](https://marketplace.visualstudio.com/items?itemName=henriblancke.vscode-dbt-formatter) VSCode extension

## airflow checklist

- [ ] This MR includes changes to the DAGs in the project
- [ ] All DAGs in this MR have a valid collection of tags
- [ ] All DAGS in this MR contain a value for `__doc___`, passed to the `doc_md` parameter of the `DAG` constructor
- [ ] There is maximum one DAG per file

## security checklist

- [ ] This MR does not introduce sensible data in the repository

## deployment checklist

- [ ] This MR does not introduce changes to the deployment process

<!-- If this MR introduces changes to the deployment process, please describe them here. -->
<!-- ### deployment changes -->

/assign me

0 comments on commit ca8b51c

Please sign in to comment.