feat(readme): initial version

CODE_OF_CONDUCT.md

@@ -0,0 +1,120 @@
+# 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.
+
+[homepage]: http://contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,164 @@
+# Contributing
+
+We opened sourced UniLLM because we believe in the power of community. We believe you can help making UniLLM better!
+We are excited to see what you will build with UniLLM and we are looking forward to your contributions. We want to make contributing to this project as easy and transparent as possible, whether it's features, bug fixes, documentation updates, guides, examples and more.
+
+## How can I contribute?
+
+Ready to contribute but seeking guidance, we have several avenues to assist you. Explore the upcoming segment for clarity on the kind of contributions we appreciate and how to jump in. Reach out directly to the UniLLM team on [Discord](https://pezzo.cc/discord) for immediate assistance! Alternatively, you're welcome to raise an issue and one of our dedicated maintainers will promptly steer you in the right direction!
+
+## Found a bug?
+
+If you find a bug in the source code, you can help us by [creating an issue](https://github.com/pezzolabs/unillm/issues/new) to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
+
+## Missing a feature?
+
+So, you've got an awesome feature in mind? Throw it over to us by [creating an issue](https://github.com/pezzolabs/unillm/issues/new) on our GitHub Repo.
+
+Planning to code a feature yourself? We love the enthusiasm, but hang on, always good to have a little chinwag with us before you burn that midnight oil. Unfortunately, not every feature might fit into our plans.
+
+- Dreaming big? Kick off by opening an issue and sketch out your cool ideas. Helps us all stay on the same page, avoid doing the same thing twice, and ensures your hard work gels well into the project.
+- Cooking up something small? Just craft it and [shoot it straight as a Pull Request](#submit-pr).
+
+## What do you need to know to help?
+
+If you want to help out with a code contribution, our project uses the following stack:
+
+- TypeScript
+- Node.js
+- Various APIs/SDKs of LLM providers
+
+If you don't feel ready to make a code contribution yet, no problem! You can also improve our documentation.
+
+# How do I make a code contribution?
+
+## Good first issues
+
+Are you new to open source contribution? Wondering how contributions work in our project? Here's a quick rundown.
+
+Find an issue that you're interested in addressing, or a feature that you'd like to add.
+You can use [this view](https://github.com/pezzolabs/unillm/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) which helps new contributors find easy gateways into our project.
+
+## Step 1: Make a fork
+
+Fork the UniLLM repository to your GitHub organization/account. This means that you'll have a copy of the repository under _your-GitHub-username/repository-name_.
+
+## Step 2: Clone the repository to your local machine
+
+```
+git clone https://github.com/{your-GitHub-username}/unillm.git
+
+```
+
+## Step 3: Prepare the development environment
+
+Set up and run the development environment on your local machine:
+
+**BEFORE** you run the following steps make sure:
+
+1. You have typescript installed locally on you machine `npm install -g typescript`
+2. You are using node version: ^18.16.0 || ^14.0.0"
+3. You are using npm version: ^8.1.0 || ^7.3.0"
+4. You have `docker` installed and running on your machine
+
+```shell
+cd unillm
+npm install
+```
+
+## Step 4: Create a branch
+
+Create a new branch for your changes.
+In order to keep branch names uniform and easy-to-understand, please use the following conventions for branch naming.
+Generally speaking, it is a good idea to add a group/type prefix to a branch.
+Here is a list of good examples:
+
+- for docs change : docs/{ISSUE_NUMBER}-{CUSTOM_NAME}
+- for new features : feat/{ISSUE_NUMBER}-{CUSTOM_NAME}
+- for bug fixes : fix/{ISSUE_NUMBER}-{CUSTOM_NAME}
+
+```jsx
+git checkout -b branch-name-here
+```
+
+## Step 5: Make your changes
+
+Update the code with your bug fix or new feature.
+
+## Step 6: Add the changes that are ready to be committed
+
+Stage the changes that are ready to be committed:
+
+```jsx
+git add .
+```
+
+## Step 7: Commit the changes (Git)
+
+Commit the changes with a short message. (See below for more details on how we structure our commit messages)
+
+```jsx
+git commit -m "<type>(<package>): <subject>"
+```
+
+## Step 8: Push the changes to the remote repository
+
+Push the changes to the remote repository using:
+
+```jsx
+git push origin branch-name-here
+```
+
+## Step 9: Create Pull Request
+
+In GitHub, do the following to submit a pull request to the upstream repository:
+
+1.  Give the pull request a title and a short description of the changes made. Include also the issue or bug number associated with your change. Explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.
+
+Remember, it's okay if your pull request is not perfect (no pull request ever is). The reviewer will be able to help you fix any problems and improve it!
+
+2.  Wait for the pull request to be reviewed by a maintainer.
+
+3.  Make changes to the pull request if the reviewing maintainer recommends them.
+
+Celebrate your success after your pull request is merged :-)
+
+## Git Commit Messages
+
+We structure our commit messages like this:
+
+```
+<type>(<package>): <subject>
+```
+
+Examples:
+
+```
+fix(docs): fix title
+fix(unillm-node): better error handling
+```
+
+### Types:
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Changes to the documentation
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing or correcting existing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
+
+### Packages:
+
+- **`unillm-node`**: Node.js SDK for UniLLM
+- **`apps/demo`**: Demo application
+- **`apps/docs`**: UniLLM's official documentation
+
+## Code of conduct
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+[Code of Conduct](https://github.com/pezzolabs/unillm/blob/main/CODE_OF_CONDUCT.md)
+
+Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy.