From 927c79bb55cd84905eee32b4d7fcbf02ba475f8e Mon Sep 17 00:00:00 2001 From: nitnelave Date: Mon, 30 Oct 2023 22:56:51 +0100 Subject: [PATCH] github: Create issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++ .github/ISSUE_TEMPLATE/integration-request.md | 25 ++++++++++++++++ 3 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/integration-request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9ccd7b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Logs** +If applicable, add logs to explain the problem. +LLDAP should be started in verbose mode (`LLDAP_VERBOSE=true` env variable, or `verbose = true` in the config). Include the logs in triple-backtick "```" +If integrating with another service, please add its configuration (paste it or screenshot it) as well as any useful logs or screenshots (showing the error, for instance). + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..1152d7f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE REQUEST]" +labels: enhancement +assignees: '' + +--- + +**Motivation** +Why do you want the feature? What problem do you have, what use cases would it enable? + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. You can include workarounds that are currently possible. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/integration-request.md b/.github/ISSUE_TEMPLATE/integration-request.md new file mode 100644 index 0000000..d7f63b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/integration-request.md @@ -0,0 +1,25 @@ +--- +name: Integration request +about: Request for integration with a service +title: "[INTEGRATION]" +labels: integration +assignees: '' + +--- + +**Checklist** +- [ ] Check if there is already an [example config](https://github.com/lldap/lldap/tree/main/example_configs) for it. +- [ ] Try to figure out the configuration values for the new service yourself. + - You can use other example configs for inspiration. + - If you're having trouble, you can ask on [Discord](https://discord.gg/h5PEdRMNyP) or create an issue. + - If you succeed, make sure to contribute an example configuration, or a configuration guide. +- If you hit a block because of an unimplemented feature, create an issue. + +**Description of the service** +Quick summary of what the service is and how it's using LDAP. Link to the service's documentation on configuring LDAP. + +**What you've tried** +A sample configuration that you've tried. + +**What's not working** +Error logs, error screenshots, features that are not working, missing features.