Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/DISCUSSION_TEMPLATE/feature_ideas.yml
Original file line number Diff line number Diff line change
@@ -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
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug Report
about: Report a bug or unexpected behavior
title: "[Bug] "
labels: bug
assignees: ""
---

## Description

<!-- A clear description of what the bug is -->

## Steps to Reproduce

1.
2.
3.

## Expected Behavior

<!-- What you expected to happen -->

## Actual Behavior

<!-- What actually happened -->

## Code Example

<!-- If applicable, add a minimal code example that reproduces the issue -->

```tsx
// Your code here
```

## Environment

- **SDK Version**:
- **Framework**: (Next.js / React / etc.)
- **Node Version**:
- **Browser**: (if applicable)
- **OS**:

## Screenshots / Logs

<!-- If applicable, add screenshots or error logs -->

## Additional Context

<!-- Add any other context about the problem here -->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Feature Request
about: Suggest an idea or new feature for the Copilot SDK
title: "[Feature] "
labels: enhancement
assignees: ""
---

## Summary

<!-- A clear and concise description of the feature you'd like -->

## Problem / Use Case

<!-- What problem does this solve? What's your use case? -->

## Proposed Solution

<!-- How do you think this should work? Include code examples if possible -->

```tsx
// Example usage (if applicable)
```

## Alternatives Considered

<!-- Any alternative solutions or features you've considered? -->

## Additional Context

<!-- Add any other context, screenshots, or examples here -->

---

**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)
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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 do you need help with? -->

## What have you tried?

<!-- What approaches have you already attempted? -->

## Code / Context

<!-- Share relevant code or context if applicable -->

```tsx
// Your code here
```

## Environment

- **SDK Version**:
- **Framework**: (Next.js / React / etc.)

---

**Note:** For general discussions, consider using [GitHub Discussions](../../discussions) instead.
44 changes: 44 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## Description

<!-- What does this PR do? Link to related issue if applicable -->

Fixes #

## Changes

<!-- List the main changes in this PR -->

-
-
-

## Type of Change

<!-- Check all that apply -->

- [ ] 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

<!-- How has this been tested? -->

- [ ] I've tested this locally
- [ ] I've added/updated tests
- [ ] All existing tests pass

## Checklist

<!-- Check all that apply -->

- [ ] 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)

<!-- Add screenshots to help explain your changes -->
35 changes: 35 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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)

<br />

Expand Down
62 changes: 62 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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!