From e3f3f055f157acfda6437d3ff8817c143df5393e Mon Sep 17 00:00:00 2001 From: deowk Date: Thu, 16 May 2024 14:26:50 +0200 Subject: [PATCH] docs: update contribution guide and issue template --- .github/ISSUE_TEMPLATE/1-docs-bug.yaml | 58 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + CONTRIBUTING.md | 18 ++++++++ 3 files changed, 77 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-docs-bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/1-docs-bug.yaml b/.github/ISSUE_TEMPLATE/1-docs-bug.yaml new file mode 100644 index 0000000..529deb0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-docs-bug.yaml @@ -0,0 +1,58 @@ +name: 'Docs or aiblock.dev Bug Report' +description: Report an issue in aiblocks documentation or aiblock.dev application + +body: + - type: textarea + id: description + attributes: + label: Describe the problem that you experienced + validations: + required: true + + - type: input + id: affected-url + attributes: + label: Enter the URL of the topic with the problem + + - type: textarea + id: documentation-goal + attributes: + label: Describe what you were looking for in the documentation + + - type: textarea + id: reproduction-steps + attributes: + label: Describe the actions that led you to experience the problem + + - type: textarea + id: expected-vs-actual-behavior + attributes: + label: Describe what you want to experience that would fix the problem + + - type: textarea + id: screenshot + attributes: + label: Add a screenshot if that helps illustrate the problem + + - type: textarea + id: exception-or-error + attributes: + label: If this problem caused an exception or error, please paste it here + render: true + placeholder: | + ``` + Paste the exception or error here inside a markdown code block, + which is annotated by three grave \(`\) characters before and after the text block. + ``` + + - type: textarea + id: browser-info + attributes: + label: If the problem is browser-specific, please specify the device, OS, browser, and version + render: true + + - type: textarea + id: additional-info + attributes: + label: Provide any additional information here in as much as detail as you can + render: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 472cbbe..3bdbc0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,10 @@ - [Submission Guidelines](#submit) - [Commit Message Guidelines](#commit) +## Found an Issue? + +If you find an issue in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix. + ## Branching Strategy We have a main and branch from main to our feature/fix branches. The tip of main is considered 'latest develop' and then we tags in main that represent specific releases. @@ -28,6 +32,20 @@ We have a main and branch from main to our feature/fix branches. The tip of main ## Submission Guidelines +## Submitting an Issue + +Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. + +A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. + +We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase, but we really need to isolate the problem before we can fix it. + +Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. + +You can file new issues by selecting from our [new issue templates](https://github.com/aiblockofficial/aiblock.dev/issues/new/choose) and filling out the issue template. + ### Submitting a Pull Request (PR) Before you submit your Pull Request (PR) consider the following guidelines: