Skip to content

Commit d9eab27

Browse files
juicycleffjuicycleff
committed
chore: Update contributing guidelines and Makefile for project renaming and automation improvements
This commit updates the CONTRIBUTING.md file to reflect the project's new name, changing references from "flutter-game-framework" to "gameframework." Additionally, the Makefile has been enhanced with new commands for version management, including version-check and version-bump, to streamline the release process. These changes aim to improve clarity in documentation and automate version handling across the project.
1 parent 7637cba commit d9eab27

14 files changed

Lines changed: 1800 additions & 10 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below.
10+
11+
- type: dropdown
12+
id: package
13+
attributes:
14+
label: Which package is affected?
15+
multiple: true
16+
options:
17+
- gameframework (core)
18+
- gameframework_unity
19+
- gameframework_unreal
20+
- Example app
21+
- Documentation
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Bug Description
29+
description: A clear and concise description of what the bug is
30+
placeholder: Tell us what went wrong
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Steps to Reproduce
38+
description: Steps to reproduce the behavior
39+
placeholder: |
40+
1. Initialize engine with '...'
41+
2. Call method '...'
42+
3. See error
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: expected
48+
attributes:
49+
label: Expected Behavior
50+
description: What did you expect to happen?
51+
placeholder: Describe the expected behavior
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: actual
57+
attributes:
58+
label: Actual Behavior
59+
description: What actually happened?
60+
placeholder: Describe what actually happened
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: code
66+
attributes:
67+
label: Code Sample
68+
description: Please provide a minimal code sample that reproduces the issue
69+
render: dart
70+
placeholder: |
71+
import 'package:gameframework/gameframework.dart';
72+
73+
void main() {
74+
// Your code here
75+
}
76+
77+
- type: textarea
78+
id: logs
79+
attributes:
80+
label: Logs / Error Messages
81+
description: Please paste any relevant logs or error messages
82+
render: shell
83+
84+
- type: dropdown
85+
id: platforms
86+
attributes:
87+
label: Platform(s) Affected
88+
multiple: true
89+
options:
90+
- Android
91+
- iOS
92+
- macOS
93+
- Windows
94+
- Linux
95+
- Web
96+
validations:
97+
required: true
98+
99+
- type: input
100+
id: flutter-version
101+
attributes:
102+
label: Flutter Version
103+
description: Output of `flutter --version`
104+
placeholder: "Flutter 3.27.0"
105+
validations:
106+
required: true
107+
108+
- type: input
109+
id: package-version
110+
attributes:
111+
label: Package Version
112+
description: Version of gameframework package you're using
113+
placeholder: "0.0.1"
114+
validations:
115+
required: true
116+
117+
- type: dropdown
118+
id: engine
119+
attributes:
120+
label: Game Engine (if applicable)
121+
options:
122+
- Unity
123+
- Unreal Engine
124+
- N/A
125+
validations:
126+
required: true
127+
128+
- type: input
129+
id: engine-version
130+
attributes:
131+
label: Engine Version (if applicable)
132+
placeholder: "Unity 2022.3.20f1 or Unreal 5.3.2"
133+
134+
- type: textarea
135+
id: additional
136+
attributes:
137+
label: Additional Context
138+
description: Add any other context about the problem here
139+
140+
- type: checkboxes
141+
id: checklist
142+
attributes:
143+
label: Pre-submission Checklist
144+
options:
145+
- label: I have searched for existing issues
146+
required: true
147+
- label: I have provided a minimal code sample
148+
required: true
149+
- label: I have included relevant logs/error messages
150+
required: true
151+
- label: I am using the latest version of the package
152+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://github.com/xraph/gameframework#readme
5+
about: Read the documentation for setup guides and examples
6+
- name: 💬 Discussions
7+
url: https://github.com/xraph/gameframework/discussions
8+
about: Ask questions and discuss ideas with the community
9+
- name: 📦 pub.dev
10+
url: https://pub.dev/packages/gameframework
11+
about: View package details and API documentation on pub.dev

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please fill out the form below.
10+
11+
- type: dropdown
12+
id: package
13+
attributes:
14+
label: Which package should this feature be added to?
15+
multiple: true
16+
options:
17+
- gameframework (core)
18+
- gameframework_unity
19+
- gameframework_unreal
20+
- Example app
21+
- Documentation
22+
- New package
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: Problem Statement
30+
description: What problem does this feature solve? What use case does it address?
31+
placeholder: I'm always frustrated when...
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Proposed Solution
39+
description: Describe the solution you'd like to see
40+
placeholder: I would like to have...
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: alternatives
46+
attributes:
47+
label: Alternatives Considered
48+
description: Have you considered any alternative solutions or workarounds?
49+
placeholder: I've tried...
50+
51+
- type: textarea
52+
id: api-design
53+
attributes:
54+
label: API Design (if applicable)
55+
description: If you have ideas about the API, share them here
56+
render: dart
57+
placeholder: |
58+
// Example usage
59+
final controller = await UnityController.create(
60+
newFeature: true,
61+
featureOptions: FeatureOptions(...),
62+
);
63+
64+
- type: dropdown
65+
id: priority
66+
attributes:
67+
label: Priority
68+
description: How important is this feature to you?
69+
options:
70+
- Low - Nice to have
71+
- Medium - Would be helpful
72+
- High - Blocking my use case
73+
- Critical - Cannot use package without this
74+
validations:
75+
required: true
76+
77+
- type: dropdown
78+
id: platforms
79+
attributes:
80+
label: Target Platform(s)
81+
multiple: true
82+
options:
83+
- Android
84+
- iOS
85+
- macOS
86+
- Windows
87+
- Linux
88+
- Web
89+
- All platforms
90+
validations:
91+
required: true
92+
93+
- type: textarea
94+
id: use-case
95+
attributes:
96+
label: Use Case
97+
description: Describe your use case in detail
98+
placeholder: I'm building an AR app that needs...
99+
validations:
100+
required: true
101+
102+
- type: textarea
103+
id: additional
104+
attributes:
105+
label: Additional Context
106+
description: Add any other context, mockups, or references here
107+
108+
- type: checkboxes
109+
id: contribution
110+
attributes:
111+
label: Contribution
112+
options:
113+
- label: I am willing to submit a PR for this feature
114+
required: false
115+
- label: I am willing to help test this feature
116+
required: false
117+
118+
- type: checkboxes
119+
id: checklist
120+
attributes:
121+
label: Pre-submission Checklist
122+
options:
123+
- label: I have searched for existing feature requests
124+
required: true
125+
- label: This feature aligns with the project's goals
126+
required: true
127+
- label: I have clearly described the problem and solution
128+
required: true

0 commit comments

Comments
 (0)