Skip to content

Commit 9d46247

Browse files
authored
Issue Templates (#108)
* docs: adding templates for github Clarification on security policy. Fixed readme title. * chore: changes to templates
1 parent 21e92bd commit 9d46247

File tree

5 files changed

+81
-16
lines changed

5 files changed

+81
-16
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 🐞 Bug Report
2+
description: File a new bug report
3+
title: '[Bug]: <title>'
4+
labels: [bug, needs triage]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: 'Is there an existing issue for this?'
9+
description: 'Please [search the issues](https://github.com/lowcoder-org/lowcoder) to check if this bug has already been reported.'
10+
options:
11+
- label: 'I have searched the existing issues'
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: 'Current Behavior'
16+
description: 'Describe the problem you are experiencing. Screenshots are welcome.'
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: 'Expected Behavior'
22+
description: 'Describe what you expect to happen instead.'
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: 'Steps to reproduce'
28+
description: |
29+
Please provide a the _concise_ set of actions to reproduce the issue. Providing these steps is essential to fix the bug quickly.
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: 'Environment'
35+
description: 'Please provide the information about your environment. E.g. operating system, what version of Lowcoder are you running etc.'
36+
validations:
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Additional Information
41+
description: Any relevant links or references that will help us resolve the bug.
42+
validations:
43+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Help on Discord
4+
url: https://discord.gg/yw4y4bkZUy
5+
about: Get help from other Lowcoders on the official Discord.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: 💡 Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feat]:"
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1+
> **Note**
2+
> Lowcoder continues from the abandoned Openblocks project. For more information [read our manifesto](MANIFESTO.md).
3+
14
<div align="center">
2-
<h1 style="border-bottom: none">
3-
<b>Lowcoder</b><br />
4-
The Open Source Retool Alternative
5-
</h1>
6-
<p>
7-
Build internal tools fast, with no limitations
8-
</p>
5+
<h1 style="border-bottom: none; margin-bottom: 0">Lowcoder</h1>
6+
<h3 style="margin-top: 0">The Open Source Retool Alternative</h3>
7+
<p>
8+
Build internal tools fast, with no limitations
9+
</p>
910
</div>
1011

11-
> **Note**
12-
> Lowcoder continues from the abandoned Openblocks project. For more information read our [manifesto](MANIFESTO.md).
13-
1412
<img src="/docs/.gitbook/assets/Bu2fpz1h01.gif"/>
1513

1614
## 📢 Use Lowcoder in 3 steps
1715
1. Connect to any data sources or APIs.
1816
2. Build UI with 50+ components.
1917
3. Share with colleagues and customers.
18+
2019
## 💡 Why Lowcoder
2120
It's cumbersome to create a single app. You had to design user interfaces, write code in multiple languages and frameworks, and understand how all of that code works together.
2221

docs/security.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# Security
1+
# Reporting Security Issues
22

3-
## Does Lowcoder store my data?
3+
If you believe you have found a security vulnerability in Lowcoder, we encourage you to let us know right away. We will investigate all legitimate reports and do our best to quickly address the problem.
44

5-
No, Lowcoder doesn't store any data returned from your APIs or database queries.
5+
Please contact any of the following maintainers directly:
66

7-
Lowcoder only serves as a proxy between client side and your data sources. When you query your APIs or databases, Lowcoder server connects to the data source with your credentials, forwards the request, and returns the result data to the browser. During the whole process, Lowcoder doesn't store any data from your requests or responses.
8-
9-
Lowcoder also provides a self-hosted version. You can deploy self-hosted Lowcoder images on your own device, on-premise deployment ensures you have total control over your resources and that your data is securely stored.
7+
* [Jan Richter](mailto:falnyr@gmail.com)
8+
* [Ludovit Mikula](mailto:ludovit.mikula@mikori.sk)

0 commit comments

Comments
 (0)