[damned-lies] chore: add gitlab templates for issues and mr



commit 0ecb99890870c207d1218bba84fdfcb0f6c4a3cf
Author: Guillaume Bernard <associations guillaume-bernard fr>
Date:   Fri Jul 9 19:38:01 2021 +0200

    chore: add gitlab templates for issues and mr

 .gitlab/issue_templates/Bug.md                   | 33 +++++++++++++++++
 .gitlab/issue_templates/Feature Proposal.md      | 38 +++++++++++++++++++
 .gitlab/issue_templates/l10n.gnome.org.md        | 34 +++++++++++++++++
 .gitlab/merge_request_templates/Merge Request.md | 47 ++++++++++++++++++++++++
 4 files changed, 152 insertions(+)
---
diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md
new file mode 100644
index 00000000..29437288
--- /dev/null
+++ b/.gitlab/issue_templates/Bug.md
@@ -0,0 +1,33 @@
+**Please read this!**
+
+Before opening a new issue, make sure to search for keywords in the issues filtered by the ~"Bug" label, and 
check the issue you’re about to submit isn’t a duplicate. Remove this notice if you’re confident your issue 
isn’t a duplicate.
+
+Please take time to fill in the section that are relevant to your situation. If a section is not relevant 
for your special case, feel free to remove it
+
+------
+
+### Summary
+
+(summarize the bug encountered concisely)
+
+### Steps to reproduce
+(how one can reproduce the issue. Give details about your configuration (such as the browser you are using).
+The idea here is to let the developers reproduce the bug on their own systems. If you have installed Damned 
Lies manually on your system, provide your Python version number (` python3 --version`) and the list of your 
modules (`pip list`) − remember to display them inside a block markup (```)).
+
+### What is the current *bug* behavior?
+
+(what actually happens)
+
+### What is the expected *correct* behavior?
+
+(what you should see instead)
+
+### Relevant logs and/or screenshots
+
+(paste any relevant log − please use code blocks (```) to format console output, error messages), provide 
screenshots if they can help better understanding the issue).
+
+### Possible fixes
+
+(if you can, get the link to the line of code that might be responsible for the problem. Anyway, if you can 
propose a solution, no necessarily a code fix but any information that is the beginning of a fix)
+
+/label ~"Bug"
diff --git a/.gitlab/issue_templates/Feature Proposal.md b/.gitlab/issue_templates/Feature Proposal.md
new file mode 100644
index 00000000..2e7ef0c6
--- /dev/null
+++ b/.gitlab/issue_templates/Feature Proposal.md       
@@ -0,0 +1,38 @@
+**Please read this!**
+
+Before opening a new issue, make sure to search for keywords in the issues filtered by the ~"Feature 
request" label, and check the issue you’re about to submit isn’t a duplicate. Remove this notice if you’re 
confident your issue isn’t a duplicate.
+
+Please take time to fill in the section that are relevant to your situation. If a section is not relevant 
for your special case, feel free to remove it. There are numerous sections in this document you may not fill 
by yourself, we will use them in order to synthesize discussion, and the challenges of the feature request.
+
+------
+### Description
+
+(include the issue you encountered, use cases, benefits, and/or goals)
+
+### Proposal
+
+(describe what you propose in order to fix the issue you encountered, the feature you want to be added in 
the software)
+
+#### Potential issues
+
+(list here all the problems related to the feature, when it will be implemented. Try to be as exhaustive as 
you wish/can, as this will be used to determine whether the feature should be implemented.)
+
+### Links / references
+
+(a list of links and/or references that help understand the issue, try to give solutions, clues, etc.)
+
+### Documentation blurb
+
+(write the start of the documentation of this feature here, include:
+
+1. Why should someone use it; what’s the underlying problem.
+2. What is the solution.
+3. How does someone use this)
+
+### List of tests
+
+(a list of the tests you think will be able to validate the code that fixes the issue. This is written in 
natural language and may fix the potential issues you raised just before. Don’t forget to explore the 
“limits” of the feature.)
+
+/label ~"Feature request"
+/label ~"Enhancement"
+/label ~"Needs review"
diff --git a/.gitlab/issue_templates/l10n.gnome.org.md b/.gitlab/issue_templates/l10n.gnome.org.md
new file mode 100644
index 00000000..4bd0d830
--- /dev/null
+++ b/.gitlab/issue_templates/l10n.gnome.org.md
@@ -0,0 +1,34 @@
+**Please read this!**
+
+Before opening a new issue, make sure to search for keywords in the issues filtered by the ~"l10n.gnome.org" 
label, and check the issue you’re about to submit isn’t a duplicate. Remove this notice if you’re confident 
your issue isn’t a duplicate.
+
+Please take time to fill in the section that are relevant to your situation. If a section is not relevant 
for your special case, feel free to remove it
+
+------
+
+### Summary
+
+(summarize the bug encountered concisely)
+
+### Where to find the issue
+
+(please, provide a link to the [l10n.gnome.org](https://l10n.gnome.org) where you noticed the bug. Please, 
also provide your **language settings** (the issue might be language dependent)
+
+### What you were doing
+
+(describe here the actions you were doing, if it is associated to a **Vertimus action**. What was the status 
of the module you are working on, the team language, your role inside the team, etc)
+
+### What is the current *bug* behavior?
+
+(what actually happens)
+
+### What is the expected *correct* behavior?
+
+(what you think you should see instead)
+
+### The screenshot that illustrates the issue
+
+(please, upload one or more screenshots that illustrate the issue you encountered.)
+
+/label ~"Bug"
+/label ~"l10n.gnome.org"
diff --git a/.gitlab/merge_request_templates/Merge Request.md b/.gitlab/merge_request_templates/Merge 
Request.md
new file mode 100644
index 00000000..e41132c0
--- /dev/null
+++ b/.gitlab/merge_request_templates/Merge Request.md  
@@ -0,0 +1,47 @@
+## Description
+
+(a few sentences describing the overall goals of the pull request’s commits. Including a reference to the 
source issue, using the `#` syntax.)
+
+### Migration and compatibility
+
+- [ ] The merge request **DOES NOT** update the models. If it does, **it is needed to migrate the database 
after merging**, add the label ~"Database migrations"
+- [ ] The merge request **DOES NOT** break the compatibility.
+
+## Related documents
+
+(documentation and pertinent links describing the methods implemented in the merge request.)
+
+## TODO
+
+Before being accepted, any merge request must fulfill the following requirements:
+
+- [ ] Check PEP8 writing style as described in [CONTRIBUTING.md](../../CONTRIBUTING.md).
+- [ ] Ensure existing tests are still working properly.
+- [ ] Features have been tested.
+- [ ] You used your best English for every translatable string 😀.
+- [ ] You marked every translatable string with `gettext`, `blocktrans` and/or `trans`.
+- [ ] Ensure that there is no side effect in files: changes are only related to one, and only one feature.
+- [ ] Ensure that no file has been removed by accident.
+- [ ] Document you API, as well as the behavior, if needed, in `docs`.
+- [ ] Ensure the commit history is “clean enough” (this means no extra merge commits, etc − try to `rebase` 
to clean it if possible).
+- [ ] Ensure `pipeline` succeeds.
+
+## Deploy Notes
+
+(notes regarding deployment the contained body of work. These should note any database migration, etc.)
+
+## Steps to Test or Reproduce
+
+(outline the steps to test or reproduce the merge request here. First, ensure there is no commit waiting to 
be pushed)
+
+```sh
+git checkout <feature_branch>  # Switch to the feature branch
+git fetch --all --prune  # Download new commits
+git reset --hard <remote>/<feature_branch>  # Override your local worktree with the one from remote branch
+```
+
+## Impacted Areas in Application
+
+(list general components of the application this request will affect)
+
+/label ~"Needs review"


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]