Skip to content

feat: Add fine tune endpoints in sdk #21

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant 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 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 apologizing 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 behavior include:

* 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, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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 behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
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 behavior 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
behavior 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 behavior. 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 behavior.

**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 behavior, 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][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Contributing

[fork]: /fork
[pr]: /compare
[style]: https://standardjs.com/
[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.

## Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

## Submitting a pull request

1. [Fork][fork] and clone the repository.
1. Create a new branch: `git checkout -b my-branch-name`.
1. Make your change, add tests, and make sure the tests still pass.
1. Push to your fork and [submit a pull request][pr].
1. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

- Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test`.
- Write and update tests.
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
60 changes: 60 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG]'

---

**Describe the Bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected Behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional Context**
Add any other context about the problem here.

---

**Environment (please complete the following information):**
- OS: [e.g., Windows 10, macOS 11.5.1]
- Browser [e.g., Chrome, Firefox]
- Version [e.g., 22]

---

**Optional: Proposed Solution**
If you have a solution in mind, please provide a clear and concise description.

---

**Optional: Labels**
Add relevant labels to this issue (e.g., "bug", "high priority", "needs triage").

---

**Optional: Assignees**
Assign this issue to specific users responsible for addressing it.

---

**Optional: Dependencies**
List any related issues, pull requests, or external dependencies.

---

**Optional: Testing Steps**
Provide specific steps or instructions to test the fix.

---
54 changes: 54 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Pull Request
about: Submit a pull request to contribute to the project
title: ''

---

**Description**
A clear and concise description of the changes proposed in this pull request.

**Related Issue**
Closes #[issue number]

**Motivation and Context**
Explain why these changes are necessary and provide any relevant background information.

**Proposed Changes**
Describe the changes made in this pull request in detail.

**Screenshots (if applicable)**
Add screenshots or GIFs to demonstrate the changes visually, if applicable.

**Testing Steps**
Outline the steps to test the changes made in this pull request.

**Additional Notes**
Add any additional information or notes that may be helpful for reviewers.

---

**Checklist**
Please review and complete the following checklist before submitting the pull request:

- [ ] I have read and followed the project's contributing guidelines.
- [ ] I have tested the changes locally and they are working as expected.
- [ ] I have added necessary documentation or updated existing documentation.
- [ ] I have added appropriate labels to this pull request.

---

**Optional: Assignees**
Assign this pull request to specific users responsible for reviewing and merging it.

---

**Optional: Reviewers**
Suggest specific users or teams to review this pull request.

---

**Optional: Dependencies**
List any related pull requests, issues, or external dependencies.

---
45 changes: 45 additions & 0 deletions REPORT_ABUSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Reporting Abuse Guidelines

We are committed to providing a safe and inclusive environment for all contributors in our repository. If you witness or experience any form of abuse, harassment, or inappropriate behavior, we encourage you to report it. By reporting abuse, you help us maintain a respectful community and take appropriate actions.

## Reporting Process

To report abuse, please follow these steps:

1. **Gather Information**: Collect any evidence or relevant details related to the incident, such as screenshots, links, or descriptions.

2. **Choose Reporting Method**:
- Public Report: If you feel comfortable, you can report the abuse by creating a new issue in this repository. Make sure to use the appropriate issue template and provide as much information as possible.
- Private Report: If you prefer to report privately, you can reach out to our designated abuse reporting team via [email protected]. Your report will be handled confidentially.

3. **Provide Details**: In your report, include the following information:
- Date and time of the incident.
- Description of the abusive behavior and any supporting evidence.
- Names or usernames of the individuals involved (if known).

4. **Prompt Response**: We are committed to addressing abuse reports promptly. Our team will acknowledge receipt of your report within [specify timeframe] and initiate an investigation.

## Investigation Process

Once a report is received, we will:

1. **Conduct Investigation**: Our team will conduct a thorough investigation into the reported abuse. We may reach out to the involved parties for additional information.

2. **Maintain Confidentiality**: We will treat all reports and investigations with utmost confidentiality to protect the privacy and safety of individuals involved.

3. **Take Appropriate Actions**: Based on the severity and nature of the abuse, we will take appropriate actions, which may include but are not limited to:
- Issuing a warning to the offender.
- Temporarily or permanently banning the offender from the repository.
- Escalating the matter to higher authorities or law enforcement if necessary.

4. **Communication and Updates**: We will keep you informed of the progress and outcome of the investigation, ensuring transparency throughout the process.

## Code of Conduct

Our repository operates under the guidelines outlined in our Code of Conduct. We expect all contributors to adhere to these guidelines, which promote respect, inclusivity, and professionalism. You can find the Code of Conduct at [CODE_OF_CONDUCT](https://github.com/DevCrew-io/chatgpt-ios-sdk/blob/feat/fine-tune/CODE_OF_CONDUCT.md).

## Support

If you have any questions or need further assistance regarding the reporting process, please reach out to [email protected].

We appreciate your cooperation in helping us maintain a safe and respectful environment for everyone in our repository.
30 changes: 30 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Security

## Reporting Potential Security Issues

If you discover a potential security vulnerability in this project,
please notify us immediately by sending an email to [email protected].
We appreciate your cooperation in helping us maintain the security and
integrity of our project.

When reporting issues, please provide the following information:

- Specify the affected component(s).
- Describe the steps to reproduce the issue.
- Summarize the security vulnerability and its potential impact.

To protect our users and allow us to address the vulnerability before it
becomes public knowledge, we kindly request that you contact us through
the provided email address. This will enable us to release patches and updates
to safeguard our users' applications.

## Policy

Once a reported security vulnerability is verified, our policy is as follows:

- We will promptly patch the current release branch and the immediate prior minor release branch.

- We will release new security fix updates for each patched release branch without delay.

Thank you for your collaboration in maintaining the security of our project and for helping us
create a safer environment for our users.
Loading