Skip to content

Commit

Permalink
feat: add bug and frontend feature issue yaml files
Browse files Browse the repository at this point in the history
  • Loading branch information
wajeshubham committed Jan 21, 2024
1 parent a2dcb72 commit 2a23037
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 33 deletions.
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Bug report
description: Create a report to help us improve
title: "BUG: <title>"

labels:
- bug

body:
- type: textarea
id: bug_description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reproduce_steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
validations:
required: false

- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.

- type: input
id: os_info
attributes:
label: OS
description: Operating System information (e.g., iOS).
placeholder: MacOS
validations:
required: false

- type: input
id: version_info
attributes:
label: OS Version
description: OS Version information.
placeholder: "13.1"
validations:
required: false

- type: input
id: client_info
attributes:
label: Client
description: Client information (e.g., postman, thunder client, chrome, safari).
placeholder: Postman
validations:
required: false



- type: textarea
id: additional_context
attributes:
label: Additional context or Information
description: Add any other context or any other information about the problem here.

59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/frontend_contribution.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Frontend Contribution
description: Share details about your frontend application for contribution to FreeAPI.
title: "FRONTEND: <title>"

labels:
- frontend
- enhancement

body:
- type: input
id: app_title
attributes:
label: Frontend App Title
description: Provide a title for your frontend application.
validations:
required: true

- type: textarea
id: overview
attributes:
label: Overview
description: Briefly describe your frontend application.
validations:
required: true

- type: textarea
id: detailed_features
attributes:
label: Detailed Features
description: List the features of your frontend application in detail.
validations:
required: true

- type: input
id: tech_stack
attributes:
label: Tech Stack Used
description: Specify the technologies used in your frontend application (comma-separated).
placeholder: "ReactJs, redux, tailwindCSS..."
validations:
required: true

- type: input
id: platform
attributes:
label: Built For Platform
description: Specify the platform on which this application will run.
placeholder: "web, mobile, desktop..."
validations:
required: true

- type: input
id: project_path
attributes:
label: Project Path
description: Provide the path to your project within the FreeAPI project's `examples` folder.
placeholder: E.g. $ROOT_FOLDER/examples/public/social-media/web/react-redux-tailwind/<your_project_folders>
validations:
required: true
2 changes: 2 additions & 0 deletions CONTRIBUTING_FRONTEND.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Thank you for your interest in contributing to the FreeAPI project by creating f
- the platform you intend to target.
- describe your application in detail

**IMPORTANT: Contributor must create an issue with [Frontend Contribution](https://github.com/hiteshchoudhary/apihub/blob/main/.github/ISSUE_TEMPLATE/frontend_contribution.yaml) issue template.**

This ensures coordination and prevents duplicated efforts.

## Table of Contents
Expand Down

0 comments on commit 2a23037

Please sign in to comment.