From 973a6904aaa0204fb60a21279e3d0327ad394102 Mon Sep 17 00:00:00 2001 From: Sahil Date: Thu, 5 Feb 2026 12:30:06 +0530 Subject: [PATCH 1/2] feat(docs): add Code of Conduct and Security Policy, enhance contribution guidelines - Introduced a new Code of Conduct to promote a respectful and inclusive community. - Added a Security Policy outlining supported versions and vulnerability reporting procedures. - Updated the CONTRIBUTING.md file to include templates for bug reports, feature requests, and questions, along with a section for good first issues. - Enhanced the README with links to the new contribution templates and emphasized community engagement. --- .github/DISCUSSION_TEMPLATE/feature_ideas.yml | 44 +++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 49 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.md | 38 ++++++++++++ .github/ISSUE_TEMPLATE/question.md | 32 ++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 44 +++++++++++++ CODE_OF_CONDUCT.md | 35 +++++++++++ CONTRIBUTING.md | 9 ++- README.md | 10 ++- SECURITY.md | 62 +++++++++++++++++++ 10 files changed, 327 insertions(+), 4 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/feature_ideas.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 SECURITY.md diff --git a/.github/DISCUSSION_TEMPLATE/feature_ideas.yml b/.github/DISCUSSION_TEMPLATE/feature_ideas.yml new file mode 100644 index 0000000..93c7117 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/feature_ideas.yml @@ -0,0 +1,44 @@ +title: "[Idea] " +labels: + - idea +body: + - type: markdown + attributes: + value: | + Thanks for sharing your idea! We love hearing from the community. + + - type: textarea + id: idea + attributes: + label: What's your idea? + description: Describe your feature idea or suggestion + placeholder: "I think it would be great if..." + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use case + description: How would you use this feature? What problem does it solve? + placeholder: "This would help me when..." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives or workarounds + description: Have you tried any workarounds? Are there alternative approaches? + placeholder: "Currently I'm doing X, but it would be better if..." + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Would you like to contribute? + options: + - label: I'd be willing to help implement this feature + - label: I'd be willing to help test this feature + - label: I'd be willing to help document this feature diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..37bb8e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,49 @@ +--- +name: Bug Report +about: Report a bug or unexpected behavior +title: "[Bug] " +labels: bug, needs-triage +assignees: "" +--- + +## Description + + + +## Steps to Reproduce + +1. +2. +3. + +## Expected Behavior + + + +## Actual Behavior + + + +## Code Example + + + +```tsx +// Your code here +``` + +## Environment + +- **SDK Version**: +- **Framework**: (Next.js / React / etc.) +- **Node Version**: +- **Browser**: (if applicable) +- **OS**: + +## Screenshots / Logs + + + +## Additional Context + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9e57397 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation + url: https://copilot-sdk.yourgpt.ai + about: Check out the documentation before opening an issue + - name: Discussions + url: https://github.com/yourgpt/copilot-sdk/discussions + about: Ask questions and share ideas in Discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5ad0ab9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,38 @@ +--- +name: Feature Request +about: Suggest an idea or new feature for the Copilot SDK +title: "[Feature] " +labels: enhancement, needs-triage +assignees: "" +--- + +## Summary + + + +## Problem / Use Case + + + +## Proposed Solution + + + +```tsx +// Example usage (if applicable) +``` + +## Alternatives Considered + + + +## Additional Context + + + +--- + +**Before submitting:** + +- [ ] I've searched existing issues to make sure this isn't a duplicate +- [ ] I've read the [documentation](https://copilot-sdk.yourgpt.ai) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..40795ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,32 @@ +--- +name: Question / Help +about: Ask a question or get help using the SDK +title: "[Question] " +labels: question +assignees: "" +--- + +## Your Question + + + +## What have you tried? + + + +## Code / Context + + + +```tsx +// Your code here +``` + +## Environment + +- **SDK Version**: +- **Framework**: (Next.js / React / etc.) + +--- + +**Note:** For general discussions, consider using [GitHub Discussions](../../discussions) instead. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..40d28b2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ +## Description + + + +Fixes # + +## Changes + + + +- +- +- + +## Type of Change + + + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation update +- [ ] Refactoring (no functional changes) + +## Testing + + + +- [ ] I've tested this locally +- [ ] I've added/updated tests +- [ ] All existing tests pass + +## Checklist + + + +- [ ] My code follows the project's style guidelines +- [ ] I've updated the documentation (if needed) +- [ ] I've added tests that prove my fix/feature works +- [ ] New and existing tests pass locally + +## Screenshots (if applicable) + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7f239a0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,35 @@ +# Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers by opening an issue or contacting us through GitHub. + +All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9eb03c0..5e4ffc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,10 +157,15 @@ pnpm release ## Getting Help -- Open an issue for bugs -- Start a discussion for questions +- **Bug reports**: Use our [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) +- **Feature requests**: Use our [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) +- **Questions**: Open a [Discussion](../../discussions) - Check existing issues before creating new ones +## Good First Issues + +Looking for something to work on? Check out issues labeled [`good first issue`](../../labels/good%20first%20issue) - these are great for newcomers! + ## Code of Conduct Be respectful and constructive. We're all here to build something great together. diff --git a/README.md b/README.md index a6b8e43..ede73bc 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ Production-ready AI Copilots for any product. Connect any LLM, deploy on your in [![npm version](https://img.shields.io/npm/v/@yourgpt/copilot-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@yourgpt/copilot-sdk) [![npm downloads](https://img.shields.io/npm/dm/@yourgpt/copilot-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@yourgpt/copilot-sdk) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md) +[![GitHub Stars](https://img.shields.io/github/stars/yourgpt/copilot-sdk?style=flat-square)](https://github.com/yourgpt/copilot-sdk/stargazers) [Documentation](https://copilot-sdk.yourgpt.ai) @@ -157,9 +159,13 @@ Visit **[copilot-sdk.yourgpt.ai](https://copilot-sdk.yourgpt.ai)** for full docu ## Contributing -Have any feedback? Share it with us. +We welcome contributions! Whether it's bug reports, feature requests, or code contributions. -[@0fficialRohit](https://x.com/0fficialRohit) · [@rege_dev](https://x.com/rege_dev) +- Read our [Contributing Guide](CONTRIBUTING.md) to get started +- Check out [good first issues](../../labels/good%20first%20issue) for beginner-friendly tasks +- Join the discussion in [GitHub Discussions](../../discussions) + +**Maintainers:** [@0fficialRohit](https://x.com/0fficialRohit) · [@rege_dev](https://x.com/rege_dev)
diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..82af0cd --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,62 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 2.x.x | :white_check_mark: | +| 1.x.x | :x: | + +## Reporting a Vulnerability + +We take security seriously. If you discover a security vulnerability, please report it responsibly. + +### How to Report + +**Please do NOT report security vulnerabilities through public GitHub issues.** + +Instead, please report them via [GitHub Security Advisories](https://github.com/YourGPT/copilot-sdk/security/advisories/new) (recommended) or by contacting the maintainers privately. + +### What to Include + +Please include the following information: + +- Type of vulnerability (e.g., XSS, SQL injection, etc.) +- Step-by-step instructions to reproduce the issue +- Affected versions +- Any potential impact +- Suggested fix (if you have one) + +### What to Expect + +- **Acknowledgment**: We will acknowledge receipt within 48 hours +- **Updates**: We will keep you informed of our progress +- **Credit**: We will credit you in the security advisory (unless you prefer to remain anonymous) + +### Scope + +This security policy applies to: + +- `@yourgpt/copilot-sdk` +- `@yourgpt/llm-sdk` +- Official example applications + +## Best Practices for Users + +When using the Copilot SDK: + +1. **Keep dependencies updated** - Regularly update to the latest version +2. **Validate inputs** - Always validate user inputs before passing to the SDK +3. **Secure API keys** - Never expose API keys in client-side code +4. **Use environment variables** - Store sensitive configuration in environment variables +5. **Review tool implementations** - Carefully review any custom tools for security implications + +## Security Features + +The SDK includes several security considerations: + +- Server-side tool execution (sensitive operations stay on your server) +- No client-side API key exposure required +- Sandboxed tool execution environment + +Thank you for helping keep Copilot SDK and its users safe! From bea9f0535bc4c1f2c3e29e95fae8d6573d0c9df4 Mon Sep 17 00:00:00 2001 From: Sahil Date: Thu, 5 Feb 2026 12:38:51 +0530 Subject: [PATCH 2/2] chore(templates): remove 'needs-triage' label from issue templates - Updated the bug report and feature request templates to remove the 'needs-triage' label for a cleaner issue management process. --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 37bb8e6..b3de609 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug Report about: Report a bug or unexpected behavior title: "[Bug] " -labels: bug, needs-triage +labels: bug assignees: "" --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5ad0ab9..6388ed3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature Request about: Suggest an idea or new feature for the Copilot SDK title: "[Feature] " -labels: enhancement, needs-triage +labels: enhancement assignees: "" ---