Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 48 additions & 36 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -1,102 +1,114 @@
name: '🐛 Bug Report'
description: Report a reproducible bug.
labels: ['possible bug']
description: Report a reproducible bug or unexpected behavior in Axios.
labels: ['bug', 'needs triage'] # Added 'bug' for classification and 'needs triage' for workflow
body:
- type: markdown
attributes:
value: 'Please read and follow the instructions before submitting an issue:'
value: "### 👋 Before You Submit"
- type: markdown
attributes:
value: |
- Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue).
- If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios).
- Ensure it isn't already fixed in the latest Axios version.
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
Please read and follow these steps to ensure a fast response:
- **Check the Docs:** Read all relevant [documentation](https://github.com/axios/axios/blob/master/README.md).
- **Search Existing Issues:** Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?q=is%3Aissue).
- **Check Latest Version:** Verify that the issue is still present in the **latest stable Axios version**.
- **Need Help?** If you are unsure the issue is caused by Axios or just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or a community forum (the old Gitter chat is deprecated).

- type: textarea
id: description
attributes:
label: 'Describe the bug'
description: A clear and concise description of what the bug is.
description: A clear and concise description of what the bug is and what conditions trigger it.
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: 'To Reproduce'
label: 'To Reproduce (Crucial for Debugging)'
description: |
Code snippet to reproduce, ideally if you can provide a live example in https://codesandbox.io/ sandbox or a repository that illustrates the issue.
(You can use https://codesandbox.io/p/sandbox/zen-knuth-9hvhzq as a node sandbox template, or https://codesandbox.io/s/axios-browser-issue-2l8jec as a browser template)
**If your problem is not reproducible, please file under Support or Usage Question**
Please provide a Minimal, Reproducible Example (MRE) that demonstrates the bug.

**Ideally, provide a live example in a sandbox:**
- Node Sandbox: https://codesandbox.io/p/sandbox/zen-knuth-9hvhzq
- Browser Sandbox: https://codesandbox.io/s/axios-browser-issue-2l8jec

**If your problem is not reproducible with a code example, please seek support first.**
validations:
required: false

- type: textarea
id: code-snippet
attributes:
label: 'Code snippet'
label: 'Code Snippet (Optional)'
description: If a full sandbox link isn't provided, paste the minimal problematic code here.
render: js
validations:
required: false

- type: textarea
id: expected
attributes:
label: 'Expected behavior'
description: A clear and concise description of what you expected to happen.
description: A clear and concise description of what you expected to happen when running the code.
validations:
required: false
required: true # Making expected behavior required improves quality

- type: markdown
attributes:
value: Environment
value: "### Environment Details"

- type: input
id: axios-version
attributes:
label: 'Axios Version'
placeholder: 'e.g. 0.18.0'
- type: input
id: adapter-version
attributes:
label: 'Adapter Version'
placeholder: 'e.g. XHR/HTTP'
placeholder: 'e.g. 1.6.7'
validations:
required: true # Making this required is essential for debugging

- type: input
id: browser
attributes:
label: 'Browser'
placeholder: 'e.g. Chrome, Safari'
placeholder: 'e.g. Chrome, Firefox, Mobile Safari'

- type: input
id: browser-version
attributes:
label: 'Browser Version'
placeholder: 'e.g. 42'
placeholder: 'e.g. 125.0'

- type: input
id: node-version
attributes:
label: 'Node.js Version'
description: 'node --version'
placeholder: 'e.g. 13.0.1'
description: Run `node --version` in your terminal.
placeholder: 'e.g. v20.12.2'

- type: input
id: os
attributes:
label: 'OS'
placeholder: 'e.g. iOS 16.0.2, OSX 12.6.0'
placeholder: 'e.g. macOS 14.4, Windows 11, Android 13'

- type: textarea
id: other-version
attributes:
label: 'Additional Library Versions'
description: List any relevant versions of frameworks or libraries that interact with Axios.
placeholder: |
e.g.
React 16.7,
React Native 0.58.0
React 18.2.0,
Vue 3.4.1,
React Native 0.72.7
render: bash
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: 'Additional context/Screenshots'
description: Add any other context about the problem here. If applicable, add screenshots to help explain.
render: bash
description: Add any other context about the problem here, such as relevant network logs or screenshots.
validations:
required: false

required: false
37 changes: 24 additions & 13 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,41 @@
name: '📝 Documentation'
description: Report an error or area that needs clarification.
labels: ['documentation']
name: "📝 Documentation"
description: Report an error, typo, or area that needs clarification in the documentation.
labels: ["documentation", "good first issue"] # Added 'good first issue' to encourage quick fixes
body:
- type: markdown
attributes:
value: 'If you found an area that needs clarification, feel free to open a PR or list the section/content that could be improved below'
value: "### 👋 Thank you for helping us improve our documentation!"
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
value: |
If you have already created a fix, feel free to **open a Pull Request directly**!
Otherwise, please use the fields below to report the problem.

- type: textarea
id: content
attributes:
label: 'Section/Content To Improve'
description: Quote or link to section
label: "Section/Content To Improve"
description: Please quote the confusing or incorrect text, or provide a direct link to the section in the documentation (e.g., in README.md).
validations:
required: true

- type: textarea
id: solution
attributes:
label: 'Suggested Improvement'
description: Identify what is confusing or incorrect and what could make it better
label: "Suggested Improvement"
description: Explain what is confusing or incorrect, and propose the specific changes or wording that would make it better.
validations:
required: true
- type: textarea

- type: input
id: files
attributes:
label: 'Relevant File(s)'
placeholder: e.g. README.md
render: bash
label: "Relevant File(s)"
description: Which file(s) does this documentation issue affect?
placeholder: e.g. README.md, CONTRIBUTING.md

- type: textarea
id: context
attributes:
label: "Additional Context (Optional)"
description: Add any other context that might be relevant to the documentation.
43 changes: 22 additions & 21 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,47 @@
name: '✨ Feature Request'
description: Suggest an idea or feature.
labels: ['feature']
name: "✨ Feature Request"
description: Suggest a new idea, enhancement, or feature for Axios.
labels: ["feature", "enhancement"] # Added 'enhancement' label for better classification
body:
- type: markdown
attributes:
value: 'Please read and follow the instructions before submitting an issue:'
value: "### 👋 Before You Submit"
- type: markdown
attributes:
value: |
- Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue).
- If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios).
- type: markdown
attributes:
value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'
Please take a moment to read and follow these steps:
- **Check the Docs:** Review the [README](https://github.com/axios/axios/blob/master/README.md) to ensure the functionality doesn't already exist.
- **Search Existing Issues:** Ensure your feature isn't already [requested](https://github.com/axios/axios/issues?q=is%3Aissue).
- **Need Help?** If you are just looking for usage advice, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or a community forum for support.

- type: textarea
id: description
attributes:
label: 'Is your feature request related to a problem? Please describe.'
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
label: "Is your feature request related to a problem? Please describe."
description: A clear and concise description of the problem you are trying to solve.
placeholder: I am frustrated when Axios doesn't currently support [X] because [Y reason]...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
label: "Describe the solution you would like"
description: A clear and concise description of what you want the feature to do. Include code examples or usage snippets if possible.
validations:
required: false
required: true

- type: textarea
id: alternative
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
label: "Describe alternatives you have considered"
description: Any alternative solutions, workarounds, or existing features you considered before submitting this request.
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: 'Additional context/Screenshots'
description: Add any other context or screenshots about the feature request here.
render: bash
label: "Additional Context/Screenshots"
description: Add any other context, designs, or relevant links here.
validations:
required: false
Loading