diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..2694feb2a --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,115 @@ +# Code of Conduct - Sim Studio + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behaviour that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologising to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behaviour include: + +* The use of sexualised language or imagery, and sexual attention or advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying and enforcing our standards of +acceptable behaviour and will take appropriate and fair corrective action in +response to any behaviour that they deem inappropriate, +threatening, offensive, or harmful. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will +communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behaviour may be +reported to the community leaders responsible for enforcement at . +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behaviour deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behaviour was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behaviour. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behaviour. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behaviour, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version +[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and +[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), +and was generated by [contributing.md](https://contributing.md/generator). \ No newline at end of file diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 99% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 05e874fea..720593b54 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -117,8 +117,8 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0 _Examples:_ -- `feat(auth): add social login integration` -- `fix(ui): correct misaligned button on homepage` +- `feat[auth]: add social login integration` +- `fix[ui]: correct misaligned button on homepage` - `docs: update installation instructions` Using clear and consistent commit messages makes it easier for everyone to understand the project history and aids in automating changelog generation. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 171ed6623..4743ebc74 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,39 +1,26 @@ --- name: Bug report -about: Report any issues with the platform -title: '' -labels: ['🐛 bug'] +about: Create a report to help us improve +title: "[BUG]" +labels: bug assignees: '' --- -Found a bug? Please fill out the sections below. 👍 +**Describe the bug** +A clear and concise description of what the bug is. -### Issue Summary +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error -A summary of the issue. This needs to be a clear detailed-rich summary. +**Expected behavior** +A clear and concise description of what you expected to happen. -### Steps to Reproduce +**Screenshots** +If applicable, add screenshots to help explain your problem. -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. +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 4ef518593..97ba1a469 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,28 +1,19 @@ --- name: Feature request -about: Suggest a feature or idea -title: '' -labels: ['✨ feature'] +about: Suggest an idea for this project +title: "[REQUEST]" +labels: feature assignees: '' --- -### Describe the solution you'd like +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - +**Describe the solution you'd like** +A clear and concise description of what you want to happen. -### Describe alternatives you've considered +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. - - -### Additional context - - - ---- +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 159f60b3f..4fb5b75b2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,30 +1,43 @@ -## What does this PR do? +# Pull Request Template -- Fixes #XXXX (GitHub issue number) +## Description - +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -## Mandatory Tasks (DO NOT REMOVE) +Fixes # (issue) -- [ ] 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. +## Type of change -## How should this be tested? +Please delete options that are not relevant. - +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Security enhancement +- [ ] Performance improvement +- [ ] Code refactoring (no functional changes) -- 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 +## How Has This Been Tested? -## Checklist +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. - +## 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 +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] I have updated version numbers as needed (if needed) + +## Security Considerations: + +- [ ] My changes do not introduce any new security vulnerabilities +- [ ] I have considered the security implications of my changes + + +## Additional Information: + +Any additional information, configuration or data that might be necessary to reproduce the issue or use the feature. \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 000000000..1429f0952 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,26 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 0.1.x | :white_check_mark: | + + +## Reporting a Vulnerability + +We take the security of Sim Studio seriously. If you believe you've found a security vulnerability, please follow these steps: + +1. **Do not disclose the vulnerability publicly** or to any third parties. + +2. **Email us directly** at security@simstudio.ai with details of the vulnerability. + +3. **Include the following information** in your report: + - Description of the vulnerability + - Steps to reproduce + - Potential impact + - Any suggestions for mitigation + +4. We will acknowledge receipt of your vulnerability report within 48 hours and provide an estimated timeline for a fix. + +5. Once the vulnerability is fixed, we will notify you and publicly acknowledge your contribution (unless you prefer to remain anonymous). \ No newline at end of file diff --git a/README.md b/README.md index b40eae9ae..674e75db2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,12 @@ # Sim Studio -[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289DA?logo=discord&logoColor=white)](https://discord.gg/pQKwMTvNrg) [![Twitter](https://img.shields.io/twitter/follow/simstudio?style=social)](https://x.com/simstudioai) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289DA?logo=discord&logoColor=white)](https://discord.gg/pQKwMTvNrg) +[![Twitter](https://img.shields.io/twitter/follow/simstudio?style=social)](https://x.com/simstudioai) +[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/simstudioai/sim/pulls) +[![support](https://img.shields.io/badge/support-contact%20author-purple.svg)](https://github.com/simstudioai/sim/issues) + **Sim Studio** is a powerful, user-friendly platform for building, testing, and optimizing agentic workflows. @@ -120,7 +125,7 @@ npm run dev ## Contributing -We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. +We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details. ## License