chore: added code of conduct, security guidelines. updated issue temp… · simstudioai/sim@622e05a · GitHub
Skip to content

Commit 622e05a

Browse files
waleedlatif1waleedlatif1
committed
chore: added code of conduct, security guidelines. updated issue templates, CONTRIBUTING, README
1 parent 7017cd4 commit 622e05a

7 files changed

Lines changed: 211 additions & 74 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 115 additions & 0 deletions

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0
117117

118118
_Examples:_
119119

120-
- `feat(auth): add social login integration`
121-
- `fix(ui): correct misaligned button on homepage`
120+
- `feat[auth]: add social login integration`
121+
- `fix[ui]: correct misaligned button on homepage`
122122
- `docs: update installation instructions`
123123

124124
Using clear and consistent commit messages makes it easier for everyone to understand the project history and aids in automating changelog generation.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,26 @@
11
---
22
name: Bug report
3-
about: Report any issues with the platform
4-
title: ''
5-
labels: ['🐛 bug']
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
66
assignees: ''
77
---
88

9-
Found a bug? Please fill out the sections below. 👍
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
1011

11-
### Issue Summary
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
1218

13-
A summary of the issue. This needs to be a clear detailed-rich summary.
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
1421

15-
### Steps to Reproduce
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
1624

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.
25+
**Additional context**
26+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,19 @@
11
---
22
name: Feature request
3-
about: Suggest a feature or idea
4-
title: ''
5-
labels: ['✨ feature']
3+
about: Suggest an idea for this project
4+
title: "[REQUEST]"
5+
labels: feature
66
assignees: ''
77
---
88

9-
### Describe the solution you'd like
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1011

11-
<!--
12-
Provide a clear and concise description of what you want to happen.
13-
-->
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
1414

15-
### Describe alternatives you've considered
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
1617

17-
<!--
18-
Let us know about other solutions you've considered, tried or researched.
19-
-->
20-
21-
### Additional context
22-
23-
<!--
24-
Is there anything else you can add about the proposal?
25-
You might want to link to related issues here, if you haven't already.
26-
-->
27-
28-
---
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,43 @@
1-
## What does this PR do?
1+
# Pull Request Template
22

3-
- Fixes #XXXX (GitHub issue number)
3+
## Description
44

5-
<!-- 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. -->
5+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
66

7-
## Mandatory Tasks (DO NOT REMOVE)
7+
Fixes # (issue)
88

9-
- [ ] I have self-reviewed the code (A decent size PR without self-review might be rejected).
10-
- [ ] 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.
11-
- [ ] I confirm automated tests are in place that prove my fix is effective or that my feature works.
9+
## Type of change
1210

13-
## How should this be tested?
11+
Please delete options that are not relevant.
1412

15-
<!-- 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 -->
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation update
17+
- [ ] Security enhancement
18+
- [ ] Performance improvement
19+
- [ ] Code refactoring (no functional changes)
1620

17-
- Are there environment variables that should be set?
18-
- What are the minimal test data to have?
19-
- What is expected (happy path) to have (input and output)?
20-
- Any other important info that could help to test that PR
21+
## How Has This Been Tested?
2122

22-
## Checklist
23+
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.
2324

24-
<!-- Remove bullet points below that don't apply to you -->
25+
## Checklist:
2526

26-
- I haven't read the [contributing guide](https://github.com/simstudioai/sim-studio/blob/main/CONTRIBUTING.md)
27-
- My code doesn't follow the style guidelines of this project
28-
- I haven't commented my code, particularly in hard-to-understand areas
29-
- I haven't checked if my changes generate no new warnings
30-
- I haven't checked if my changes generate no new errors
27+
- [ ] My code follows the style guidelines of this project
28+
- [ ] I have performed a self-review of my own code
29+
- [ ] I have commented my code, particularly in hard-to-understand areas
30+
- [ ] My changes generate no new warnings
31+
- [ ] I have added tests that prove my fix is effective or that my feature works
32+
- [ ] Any dependent changes have been merged and published in downstream modules
33+
- [ ] I have updated version numbers as needed (if needed)
34+
35+
## Security Considerations:
36+
37+
- [ ] My changes do not introduce any new security vulnerabilities
38+
- [ ] I have considered the security implications of my changes
39+
40+
41+
## Additional Information:
42+
43+
Any additional information, configuration or data that might be necessary to reproduce the issue or use the feature.

‎.github/SECURITY.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| 0.1.x | :white_check_mark: |
8+
9+
10+
## Reporting a Vulnerability
11+
12+
We take the security of Sim Studio seriously. If you believe you've found a security vulnerability, please follow these steps:
13+
14+
1. **Do not disclose the vulnerability publicly** or to any third parties.
15+
16+
2. **Email us directly** at security@simstudio.ai with details of the vulnerability.
17+
18+
3. **Include the following information** in your report:
19+
- Description of the vulnerability
20+
- Steps to reproduce
21+
- Potential impact
22+
- Any suggestions for mitigation
23+
24+
4. We will acknowledge receipt of your vulnerability report within 48 hours and provide an estimated timeline for a fix.
25+
26+
5. Once the vulnerability is fixed, we will notify you and publicly acknowledge your contribution (unless you prefer to remain anonymous).

‎README.md‎

Lines changed: 7 additions & 2 deletions

0 commit comments

Comments
 (0)