Merge branch 'master' into master

panjf2000 · Nov 25, 2023 · 360e302 · 360e302
2 parents fa93833 + 5cecad0
commit 360e302
Show file tree

Hide file tree

Showing 38 changed files with 1,777 additions and 666 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: [panjf2000]
 patreon: panjf2000
 open_collective: panjf2000
 ko_fi: # Replace with a single Ko-fi username

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml
@@ -0,0 +1,121 @@
+name: Bug Report
+description: Oops!..., it's a bug.
+title: "[Bug]: "
+labels: ["bug"]
+assignees:
+  - panjf2000
+body:
+  - type: markdown
+    id: tips
+    attributes:
+      value: |
+        ## Before you go any further
+        - Please read [<u>*How To Ask Questions The Smart Way*</u>](http://www.catb.org/~esr/faqs/smart-questions.html) ( Chinese translation: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)) before you file an issue formally.
+        - Keep in mind that there is always welcome to ask questions on [Gitter](https://gitter.im/ants-pool/ants).
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Actions I've taken before I'm here
+      description: Make sure you have tried the following ways but still the problem has not been solved.
+      options:
+        - label: I've thoroughly read the documentations on this issue but still have no clue.
+          required: true
+        - label: I've searched the current list of Github issues but didn't find any duplicate issues that have been solved.
+          required: true
+        - label: I've searched the internet with this issue, but haven't found anything helpful.
+          required: true
+    validations:
+      required: true
+  - type: textarea
+    id: bug-report
+    attributes:
+      label: What happened?
+      description: Describe (and illustrate) the bug that you encountered precisely.
+      placeholder: Please describe what happened and how it happened, the more details you provide, the faster the bug gets fixed.
+    validations:
+      required: true
+  - type: dropdown
+    id: major-version
+    attributes:
+      label: Major version of ants
+      description: What major version of ants are you running?
+      options:
+        - v2
+        - v1
+    validations:
+      required: true
+  - type: input
+    id: specific-version
+    attributes:
+      label: Specific version of ants
+      description: What's the specific version of ants?
+      placeholder: "For example: v2.6.0"
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      multiple: true
+      options:
+        - Linux
+        - macOS
+        - Windows
+        - BSD
+    validations:
+      required: true
+  - type: input
+    id: os-version
+    attributes:
+      label: OS version
+      description: What's the specific version of OS?
+      placeholder: "Run `uname -srm` command to get the info, for example: Darwin 21.5.0 arm64, Linux 5.4.0-137-generic x86_64"
+    validations:
+      required: true
+  - type: input
+    id: go-version
+    attributes:
+      label: Go version
+      description: What's the specific version of Go?
+      placeholder: "Run `go version` command to get the info, for example: go1.20.5 linux/amd64"
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: code
+    attributes:
+      label: Code snippets (optional)
+      description: Helpful code snippets can really speed up the process of locating root cause and fixing the bug.
+      render: go
+  - type: textarea
+    id: how-to-reproduce
+    attributes:
+      label: How to Reproduce
+      description: Steps to reproduce the result.
+      placeholder: Tell us step by step how we can replicate this bug and what we should see in the end.
+      value: |
+        Steps to reproduce the behavior:
+        1. Go to '....'
+        2. Click on '....'
+        3. Do '....'
+        4. See '....'
+    validations:
+      required: true
+  - type: dropdown
+    id: bug-in-latest-code
+    attributes:
+      label: Does this issue reproduce with the latest release?
+      description: Is this bug still present in the latest version?
+      options:
+        - It can reproduce with the latest release
+        - It gets fixed in the latest release
+        - I haven't verified it with the latest release
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml
@@ -0,0 +1,60 @@
+name: Feature Request
+description: Propose an idea to make ants even better.
+title: "[Feature]: "
+labels: ["proposal", "enhancement"]
+assignees:
+  - panjf2000
+body:
+  - type: markdown
+    id: tips
+    attributes:
+      value: |
+        ## Before you go any further
+        - Please read [<u>*How To Ask Questions The Smart Way*</u>](http://www.catb.org/~esr/faqs/smart-questions.html) ( Chinese translation: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)) before you file an issue formally.
+        - Keep in mind that there is always welcome to ask questions on [Gitter](https://gitter.im/ants-pool/ants).
+  - type: textarea
+    id: feature-request
+    attributes:
+      label: Description of new feature
+      description: Make a concise but clear description about this new feature.
+      placeholder: Describe this new feature with critical details.
+    validations:
+      required: true
+  - type: textarea
+    id: feature-scenario
+    attributes:
+      label: Scenarios for new feature
+      description: Explain why you need this feature and what scenarios can benefit from it.
+      placeholder: Please try to convince us that this new feature makes sense, also it will improve ants.
+    validations:
+      required: true
+  - type: dropdown
+    id: breaking-changes
+    attributes:
+      label: Breaking changes or not?
+      description: Is this new feature going to break the backward compatibility of the existing APIs?
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: true
+  - type: textarea
+    id: code
+    attributes:
+      label: Code snippets (optional)
+      description: Illustrate this new feature with source code, what it looks like in code.
+      render: go
+  - type: textarea
+    id: feature-alternative
+    attributes:
+      label: Alternatives for new feature
+      description: Alternatives in your mind in case that the feature can't be done for some reasons.
+      placeholder: A concise but clear description of any alternative solutions or features you had in mind.
+      value: None.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context (optional)
+      description: Any additional context about this new feature we should know.
+      placeholder: What else should we know before we start discussing this new feature?
+      value: None.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml
@@ -0,0 +1,26 @@
+name: Question
+description: Ask questions about ants.
+title: "[Question]: "
+labels: ["question", "help wanted"]
+body:
+  - type: markdown
+    id: tips
+    attributes:
+      value: |
+        ## Before you go any further
+        - Please read [<u>*How To Ask Questions The Smart Way*</u>](http://www.catb.org/~esr/faqs/smart-questions.html) ( Chinese translation: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)) before you file an issue formally.
+        - Keep in mind that there is always welcome to ask questions on [Gitter](https://gitter.im/ants-pool/ants).
+  - type: textarea
+    id: question
+    attributes:
+      label: Questions with details
+      description: What do you want to know?
+      placeholder: Describe your question with critical details here.
+    validations:
+      required: true
+  - type: textarea
+    id: code
+    attributes:
+      label: Code snippets (optional)
+      description: Illustrate your question with source code if needed.
+      render: go
diff --git a/.github/ISSUE_TEMPLATE/question_inquiry.md b/.github/ISSUE_TEMPLATE/question_inquiry.md
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,13 +1,5 @@
----
-name: Pull request
-about: Propose changes to the code
-title: ''
-labels: ''
-assignees: ''
----
-
 <!--
-Thank you for contributing to `ants`! Please fill this out to help us make the most of your pull request.
+Thank you for contributing to `ants`! Please fill this out to help us review your pull request more efficiently.
 
 Was this change discussed in an issue first? That can help save time in case the change is not a good fit for the project. Not all pull requests get merged.
 

diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,97 @@
+name-template: Ants v$RESOLVED_VERSION
+tag-template: v$RESOLVED_VERSION
+categories:
+    - title: 🧨 Breaking changes
+      labels:
+          - breaking changes
+    - title: 🚀 Features
+      labels:
+          - proposal
+          - new feature
+    - title: 🛩 Enhancements
+      labels:
+          - enhancement
+          - optimization
+    - title: 🐛 Bugfixes
+      labels:
+          - bug
+    - title: 📚 Documentation
+      labels:
+          - doc
+          - docs
+    - title: 🗃 Misc
+      labels:
+          - chores
+change-template: '- $TITLE (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - major
+  minor:
+    labels:
+      - minor
+      - new feature
+      - proposal
+  patch:
+    labels:
+      - patch
+      - bug
+      - dependencies
+  default: patch
+autolabeler:
+  - label: bug
+    title:
+      - /fix/i
+      - /bug/i
+      - /patch/i
+  - label: docs
+    files:
+      - '*.md'
+    title:
+      - /doc/i
+      - /README/i
+  - label: enhancement
+    title:
+      - /opt:/i
+      - /refactor/i
+      - /optimize/i
+      - /improve/i
+      - /update/i
+      - /remove/i
+      - /delete/i
+  - label: new feature
+    title:
+      - /feat:/i
+      - /feature/i
+      - /implement/i
+      - /add/i
+      - /minor/i
+  - label: dependencies
+    title:
+      - /dependencies/i
+      - /upgrade/i
+      - /bump up/i
+  - label: chores
+    title:
+      - /chore/i
+      - /\bmisc\b/i
+      - /cleanup/i
+      - /clean up/i
+  - label: major
+    title:
+      - /major:/i
+  - label: minor
+    title:
+      - /minor:/i
+  - label: patch
+    title:
+      - /patch:/i
+template: |
+    ## Changelogs
+    
+    $CHANGES
+
+    **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
+  
+    Thanks to all these contributors: $CONTRIBUTORS for making this release possible.