Skip to content

Commit 28051da

Browse files
waleedlatif1waleedlatif1
committed
Add .github/
1 parent 4e9d503 commit 28051da

3 files changed

Lines changed: 124 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Report any issues with the platform
4+
title: ''
5+
labels: ['🐛 bug']
6+
assignees: ''
7+
---
8+
9+
Found a bug? Please fill out the sections below. 👍
10+
11+
### Issue Summary
12+
13+
A summary of the issue. This needs to be a clear detailed-rich summary.
14+
15+
### Steps to Reproduce
16+
17+
1. (for example) Went to ...
18+
2. Clicked on...
19+
3. ...
20+
21+
Any other relevant information. For example, why do you consider this a bug and what did you expect to happen instead?
22+
23+
### Actual Results
24+
25+
- What's happening right now that is different from what is expected
26+
27+
### Expected Results
28+
29+
- This is an ideal result that the system should get after the tests are performed
30+
31+
### Technical details
32+
33+
- Browser version, screen recording, console logs, network requests: You can make a recording with [Bird Eats Bug](https://birdeatsbug.com/).
34+
- Node.js version
35+
- Anything else that you think could be an issue.
36+
37+
### Evidence
38+
39+
- How was this tested? This is quite mandatory in terms of bugs. Providing evidence of your testing with screenshots or/and videos is an amazing way to prove the bug and a troubleshooting chance to find the solution.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Feature request
3+
about: Suggest a feature or idea
4+
title: ''
5+
labels: ['✨ feature']
6+
assignees: ''
7+
---
8+
9+
### Is your proposal related to a problem?
10+
11+
<!--
12+
Provide a clear and concise description of what the problem is.
13+
For example, "I'm always frustrated when..."
14+
-->
15+
16+
(Write your answer here.)
17+
18+
### Describe the solution you'd like
19+
20+
<!--
21+
Provide a clear and concise description of what you want to happen.
22+
-->
23+
24+
(Describe your proposed solution here.)
25+
26+
### Describe alternatives you've considered
27+
28+
<!--
29+
Let us know about other solutions you've tried or researched.
30+
-->
31+
32+
(Write your answer here.)
33+
34+
### Additional context
35+
36+
<!--
37+
Is there anything else you can add about the proposal?
38+
You might want to link to related issues here, if you haven't already.
39+
-->
40+
41+
(Write your answer here.)
42+
43+
### Requirement/Document
44+
45+
<!--
46+
Is there any type of document that could support that feature?
47+
-->
48+
49+
(Share it here.)
50+
51+
---

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## What does this PR do?
2+
3+
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
4+
5+
- Fixes #XXXX (GitHub issue number)
6+
7+
<!-- Please provide a loom video for visual changes to speed up reviews
8+
Loom Video: https://www.loom.com/
9+
-->
10+
11+
## Mandatory Tasks (DO NOT REMOVE)
12+
13+
- [ ] I have self-reviewed the code (A decent size PR without self-review might be rejected).
14+
- [ ] I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
15+
- [ ] I confirm automated tests are in place that prove my fix is effective or that my feature works.
16+
17+
## How should this be tested?
18+
19+
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Write details that help to start the tests -->
20+
21+
- Are there environment variables that should be set?
22+
- What are the minimal test data to have?
23+
- What is expected (happy path) to have (input and output)?
24+
- Any other important info that could help to test that PR
25+
26+
## Checklist
27+
28+
<!-- Remove bullet points below that don't apply to you -->
29+
30+
- I haven't read the [contributing guide](https://github.com/simstudioai/sim-studio/blob/main/CONTRIBUTING.md)
31+
- My code doesn't follow the style guidelines of this project
32+
- I haven't commented my code, particularly in hard-to-understand areas
33+
- I haven't checked if my changes generate no new warnings
34+
- I haven't checked if my changes generate no new errors

0 commit comments

Comments
 (0)