From 28051da0587d13c444bcfe7acf249f312994b8d8 Mon Sep 17 00:00:00 2001 From: Waleed Latif Date: Sat, 15 Feb 2025 19:47:12 -0800 Subject: [PATCH] Add .github/ --- .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 51 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 34 +++++++++++++++ 3 files changed, 124 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..171ed6623 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Report any issues with the platform +title: '' +labels: ['🐛 bug'] +assignees: '' +--- + +Found a bug? Please fill out the sections below. 👍 + +### Issue Summary + +A summary of the issue. This needs to be a clear detailed-rich summary. + +### Steps to Reproduce + +1. (for example) Went to ... +2. Clicked on... +3. ... + +Any other relevant information. For example, why do you consider this a bug and what did you expect to happen instead? + +### Actual Results + +- What's happening right now that is different from what is expected + +### Expected Results + +- This is an ideal result that the system should get after the tests are performed + +### Technical details + +- Browser version, screen recording, console logs, network requests: You can make a recording with [Bird Eats Bug](https://birdeatsbug.com/). +- Node.js version +- Anything else that you think could be an issue. + +### Evidence + +- 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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..cf36a7393 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,51 @@ +--- +name: Feature request +about: Suggest a feature or idea +title: '' +labels: ['✨ feature'] +assignees: '' +--- + +### Is your proposal related to a problem? + + + +(Write your answer here.) + +### Describe the solution you'd like + + + +(Describe your proposed solution here.) + +### Describe alternatives you've considered + + + +(Write your answer here.) + +### Additional context + + + +(Write your answer here.) + +### Requirement/Document + + + +(Share it here.) + +--- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..41981d63a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +## What does this PR do? + + + +- Fixes #XXXX (GitHub issue number) + + + +## Mandatory Tasks (DO NOT REMOVE) + +- [ ] I have self-reviewed the code (A decent size PR without self-review might be rejected). +- [ ] 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. +- [ ] I confirm automated tests are in place that prove my fix is effective or that my feature works. + +## How should this be tested? + + + +- Are there environment variables that should be set? +- What are the minimal test data to have? +- What is expected (happy path) to have (input and output)? +- Any other important info that could help to test that PR + +## Checklist + + + +- I haven't read the [contributing guide](https://github.com/simstudioai/sim-studio/blob/main/CONTRIBUTING.md) +- My code doesn't follow the style guidelines of this project +- I haven't commented my code, particularly in hard-to-understand areas +- I haven't checked if my changes generate no new warnings +- I haven't checked if my changes generate no new errors