From e413c7972ab3a1e15182f33f1aa7ed6b8c7e0200 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Sun, 7 May 2023 00:57:46 +1200 Subject: [PATCH 1/2] docs: adding templates for github Clarification on security policy. Fixed readme title. --- .github/ISSUE_TEMPLATE/bug_report.yml | 43 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 19 ++++++++++ README.md | 19 +++++----- docs/security.md | 11 +++--- 5 files changed, 81 insertions(+), 16 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..6761cedf2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,43 @@ +name: 🐞 Bug Report +description: File a new bug report +title: '[Bug]: ' +labels: [bug, needs triage] +body: + - type: checkboxes + attributes: + label: 'Is there an existing issue for this?' + description: 'Please [search the issues](https://github.com/lowcoder-org/lowcoder) to check if this bug has already been reported.' + options: + - label: 'I have searched the existing issues' + required: true + - type: textarea + attributes: + label: 'Current Behavior' + description: 'Describe the problem you are experiencing. Screenshots are welcome.' + validations: + required: true + - type: textarea + attributes: + label: 'Expected Behavior' + description: 'Describe what you expect to happen instead.' + validations: + required: true + - type: textarea + attributes: + label: 'Steps to reproduce' + description: | + Please provide a the _concise_ set of actions to reproduce the issue. Providing these steps is essential to fix the bug quickly. + validations: + required: true + - type: textarea + attributes: + label: 'Environment' + description: 'Please provide the information about your environment. E.g. operating system, what version of Lowcoder are you running etc.' + validations: + required: false + - type: textarea + attributes: + label: Additional Information + description: Any relevant links or references that will help us resolve the bug. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..48389fbad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Help on Discord + url: https://discord.gg/yw4y4bkZUy + about: Get help from other Lowcoders on the official Discord. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..d6a9dc77a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feat]:" +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**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. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/README.md b/README.md index 09aefe9e7..d2f05b872 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,21 @@ +> **Note** +> Lowcoder continues from the abandoned Openblocks project. For more information [read our manifesto](MANIFESTO.md). + <div align="center"> -<h1 style="border-bottom: none"> - <b>Lowcoder</b><br /> - The Open Source Retool Alternative -</h1> -<p> - Build internal tools fast, with no limitations -</p> + <h1 style="border-bottom: none; margin-bottom: 0">Lowcoder</h1> + <h3 style="margin-top: 0">The Open Source Retool Alternative</h3> + <p> + Build internal tools fast, with no limitations + </p> </div> -> **Note** -> Lowcoder continues from the abandoned Openblocks project. For more information read our [manifesto](MANIFESTO.md). - <img src="/docs/.gitbook/assets/Bu2fpz1h01.gif"/> ## 📢 Use Lowcoder in 3 steps 1. Connect to any data sources or APIs. 2. Build UI with 50+ components. 3. Share with colleagues and customers. + ## 💡 Why Lowcoder 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. diff --git a/docs/security.md b/docs/security.md index 7366ef897..29746e030 100644 --- a/docs/security.md +++ b/docs/security.md @@ -1,9 +1,8 @@ -# Security +# Reporting Security Issues -## Does Lowcoder store my data? +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. -No, Lowcoder doesn't store any data returned from your APIs or database queries. +Please contact any of the following maintainers directly: -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. - -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. +* [Jan Richter](mailto:falnyr@gmail.com) +* [Ludovit Mikula](mailto:ludovit.mikula@mikori.sk) From 98f1d7de35a0fbe221c0df36d19963d38b901a30 Mon Sep 17 00:00:00 2001 From: Jan Richter <falnyr@gmail.com> Date: Sun, 7 May 2023 01:02:02 +1200 Subject: [PATCH 2/2] chore: changes to templates --- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 48389fbad..5f0d68207 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: false +blank_issues_enabled: true contact_links: - name: 💬 Help on Discord url: https://discord.gg/yw4y4bkZUy diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d6a9dc77a..ff33d54d9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,5 +1,5 @@ --- -name: Feature request +name: 💡 Feature request about: Suggest an idea for this project title: "[Feat]:" labels: enhancement