Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update Read me #10

Merged
merged 2 commits into from
Jan 22, 2025
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
2 changes: 2 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Specify files that shouldn't be modified by Fern

.github/workflows/ci.yml
.github/ISSUE_TEMPLATE
src/Client.ts
src/core/fetcher/Fetcher.ts
tests/integration
src/wrapper
src/index.ts
src/api/resources/auth/client/Client.ts
src/core/fetcher/getRequestBody.ts
CONTRIBUTING.md
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions
url: https://discuss.vectara.com/
about: Ask questions and interact with the community h
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 🐞 Typescript SDK Bug
description: File a bug about Typescript SDK
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please complete the following form to help us assist you.
- type: textarea
id: what-happened
attributes:
label: Bug Description
description: What happened?
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of typescript sdk are you using?
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Which steps should someone take to run into the same error?
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs/Tracbacks
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to the Vectara Python SDK

We appreciate your interest in contributing to the Vectara Python SDK!

---

## About This SDK

This SDK is **programmatically generated**, meaning that much of the code is automatically created by a generation system. As a result:
1. **Direct changes to the SDK code** (e.g., methods, classes) would need to be replicated in the generation system.
2. Contributions such as **proof-of-concepts** or **bug fixes** are welcome, but they may require additional work on our end to integrate into the generation process.

---

## How to Contribute

### 1. Open an Issue
Before submitting a pull request (PR), we encourage you to:
- Open an issue to describe your proposed changes.
- Discuss the idea with the maintainers to ensure alignment with the project goals.

## Getting started

1. Fork the repository and clone your fork.
2. Create a new branch for your changes (e.g. `bug-fix-1234`)
3. Make your changes in the new branch and test.
4. Commit and push your changes to your fork. Add useful comments to describe your changes.
5. Create a pull request following the guidelines in the [Submitting Pull Requests](#submitting-pull-requests) section.

## Contributing

### Reporting bugs

If you find a bug in the project, please create an issue on GitHub with the following information:

- A clear, descriptive title for the issue.
- A description of the problem, including steps to reproduce the issue.
- Any relevant logs, screenshots, or other supporting information.

### Suggesting enhancements

If you have an idea for a new feature or improvement, please create an issue on GitHub with the following information:

- A clear, descriptive title for the issue.
- A detailed description of the proposed enhancement, including any benefits and potential drawbacks.
- Any relevant examples, mockups, or supporting information.

### Submitting pull requests

When submitting a pull request, please ensure that your changes meet the following criteria:

- Your pull request should be atomic and focus on a single change.
- You should have thoroughly tested your changes with multiple different scenarios.
- You should have considered potential risks and mitigations for your changes.
- You should have documented your changes clearly and comprehensively.
- Please do not include any unrelated or "extra" small tweaks or changes.
Loading
Loading