Skip to content

Commit bf71b30

Browse files
CodeWithKyrianCodeWithKyrian
committed
Add issues and pull requests templates
1 parent 798fac2 commit bf71b30

7 files changed

+185
-0
lines changed

‎.github/ISSUE_TEMPLATE/1_bug-report.yml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "🐛 Bug Report"
2+
description: Submit a bug report to help us improve Transformers PHP.
3+
labels: [ "bug" ]
4+
body:
5+
- type: textarea
6+
id: system-info
7+
attributes:
8+
label: System Info
9+
description: Please share your system info with us. This may include your operating system, Server software, Framework/CMS (if applicable) and its version (e.g., Laravel, Symfony), and any other relevant information.
10+
placeholder: "Operating System, Server Software, Framework/CMS, Framework/CMS Version, etc."
11+
validations:
12+
required: true
13+
14+
- type: input
15+
id: php-version
16+
attributes:
17+
label: PHP Version
18+
description: What version of PHP are you running? Please be as specific as possible
19+
placeholder: 8.1.20
20+
validations:
21+
required: true
22+
23+
- type: checkboxes
24+
id: environment-or-platform
25+
attributes:
26+
label: Environment/Platform
27+
description: "The environment I am running in:"
28+
options:
29+
- label: "Command-line application"
30+
- label: "Web application"
31+
- label: "Serverless"
32+
- label: "Other (please specify)"
33+
34+
- type: textarea
35+
id: description
36+
validations:
37+
required: true
38+
attributes:
39+
label: Description
40+
description: A clear and concise description of the bug, as well as what you expected to happen.
41+
42+
- type: textarea
43+
id: reproduction
44+
validations:
45+
required: true
46+
attributes:
47+
label: Reproduction
48+
description: |
49+
Please provide a code sample that reproduces the problem you ran into. If you have code snippets, error messages, or stack traces, please provide them here as well.
50+
Important! Use [code tags](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) to correctly format your code.
51+
52+
placeholder: |
53+
Steps to reproduce the behavior:
54+
55+
1.
56+
2.
57+
3.

‎.github/ISSUE_TEMPLATE/2_feature_request.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: " Feature request"
2+
description: Submit a proposal/request for a new Transformers PHP feature
3+
labels: [ "enhancement" ]
4+
body:
5+
- type: dropdown
6+
id: feature-type
7+
attributes:
8+
label: Type of feature request
9+
description: "What kind of feature are you requesting?"
10+
options:
11+
- "🌟New Model"
12+
- "🔧New Pipeline"
13+
- "🚀Enhancement"
14+
- "📦Other (please specify)"
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: feature-description
20+
validations:
21+
required: true
22+
attributes:
23+
label: Feature description
24+
description: |
25+
Please provide a clear and concise description of the feature you are requesting. If the feature is related to a new model or pipeline, include details like its functionality and purpose.
26+
For enhancements, describe the desired change and its benefits.
27+
28+
- type: textarea
29+
id: motivation
30+
validations:
31+
required: true
32+
attributes:
33+
label: Motivation
34+
description: |
35+
Please outline the motivation for the proposal. Why is it important that we add this feature? What is your intended use case?
36+
37+
- type: textarea
38+
id: contribution
39+
validations:
40+
required: true
41+
attributes:
42+
label: Your contribution
43+
description: |
44+
Is there any way that you could help, e.g. by submitting a PR?

‎.github/ISSUE_TEMPLATE/3_question.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "❓ Question about Transformers PHP"
2+
description: Ask your questions about using Transformers PHP
3+
labels: [ "question" ]
4+
body:
5+
- type: textarea
6+
id: question
7+
validations:
8+
required: true
9+
attributes:
10+
label: Your question
11+
description: Please clearly state your question about using Transformers PHP. The more details you provide, the better we can assist you.
12+
placeholder: "For example, I'm having trouble understanding how to use the [Model Name] model for sentiment analysis. Can you please provide some guidance?"
13+
14+
- type: textarea
15+
id: context
16+
validations:
17+
required: false # Optional field
18+
attributes:
19+
label: Context (optional)
20+
description: If necessary, provide additional context about your question. This could include - The specific functionality you're trying to achieve, any code snippets you're working with, or error messages you're encountering (if applicable).
21+
22+
- type: input
23+
id: reference
24+
validations:
25+
required: false # Optional field
26+
attributes:
27+
label: Reference (optional)
28+
description: If your question relates to specific documentation or code examples, please provide a link here.

‎.github/ISSUE_TEMPLATE/config.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: true
2+
version: 2.1
3+
contact_links:
4+
- name: Documentation
5+
url: https://codewithkyrian.github.io/transformers-php
6+
about: Read the Transformers PHP documentation

‎.github/PULL_REQUEST_TEMPLATE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!--
2+
- Fill in the form below correctly. This will help the OpenAI PHP team to understand the PR and also work on it.
3+
-->
4+
5+
### What:
6+
7+
- [ ] Bug Fix
8+
- [ ] New Feature
9+
10+
### Description:
11+
12+
<!-- describe what your PR is solving -->
13+
14+
### Related:
15+
16+
<!-- link to the issue(s) your PR is solving. If it doesn't exist, remove the "Related" section. -->

‎.github/workflows/changelog.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: "Update Changelog"
2+
3+
on:
4+
release:
5+
types: [released]
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
update:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
with:
18+
ref: main
19+
20+
- name: Update Changelog
21+
uses: stefanzweifel/changelog-updater-action@v1
22+
with:
23+
latest-version: ${{ github.event.release.name }}
24+
release-notes: ${{ github.event.release.body }}
25+
26+
- name: Commit updated CHANGELOG
27+
uses: stefanzweifel/git-auto-commit-action@v5
28+
with:
29+
branch: main
30+
commit_message: Update CHANGELOG
31+
file_pattern: CHANGELOG.md

‎CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
3+
All notable changes to `transformers-php` will be documented in this file.

0 commit comments

Comments
 (0)