Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Docs] update license / code-of-conduct / readme #151

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 5, 2025
Merged

[Docs] update license / code-of-conduct / readme #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# 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, caste, color, 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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
21 changes: 21 additions & 0 deletions LICENCE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT Licence

Copyright (c) 2025 The LangChain Open Tutorial team, Seoul, South Korea.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
49 changes: 29 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
# 🦜️🔗 LangChain OpenTutorial
# 🦜️🔗 The LangChain Open Tutorial for Everyone

Overview, Tutorial, and Examples of [LangChain](https://github.com/langchain-ai/langchain)
This tutorial delves into [LangChain](https://github.com/langchain-ai/langchain), starting from an overview then providing practical examples.

While a [Korean version of the tutorial](https://github.com/teddylee777/langchain-kr) already exists, this tutorial offers:
[![status: experimental](https://github.com/GIScience/badges/raw/master/status/experimental.svg)](https://github.com/GIScience/badges#experimental)
[![licence: MIT](https://img.shields.io/badge/Licence-MIT-yellow.svg)](https://opensource.org/licenses/MIT "MIT License")

- **Translation for Global Users**: Adapted to serve a worldwide audience.
- **Expanded Content**: Covers the recently updated main features of LangChain and LangGraph, providing deeper insights and advanced topics.
- **Practical Case Studies**: Enriched with more real-world applications and examples to enhance practical understanding and utilization of LangChain.
The LangChain community in Seoul is excited to announce the LangChain OpenTutorial, a brand-new resource designed for everyone. This tutorial builds upon the foundation of the existing tutorial available here: [link](https://github.com/teddylee777/langchain-kr) written in Korean.

This comprehensive resource aims to provide both new and existing users with up-to-date information and real-world applications to enhance their understanding and utilization of LangChain.
Within this new repository, we offer the following enhancements to benefit users of all skill levels:

## 📚 References
- [langchain-ai](https://github.com/langchain-ai/langchain) 📖
- [LangGraph GitHub](https://github.com/langchain-ai/langgraph)
- [LangChain Documentation](https://python.langchain.com/docs/introduction/)
- [OpenAI API Reference](https://platform.openai.com/docs/introduction) 🤖
- **Addressing global use cases** for internatial users,
- **Diving deep into cutting-edge features** including the recent updates available at the latest version of LangChain and LangGraph release, and
- **Demonstrating additional goodies** that showcase real-world uses and further applications.

## 🔗 Useful Links
- **LangChain Korean Tutorial(wikidocs)**: [WikiDocs](https://wikidocs.net/book/14314)
- **LangChain Korean Tutorial(github)**: [GitHub Repository](https://github.com/teddylee777/langchain-kr)
- **YouTube Channel**: [Teddy Note](https://www.youtube.com/channel/UCt2wAAXgm87ACiQnDHQEW6Q) 🎥
- **Blog**: [Teddy Note](https://teddylee777.github.io) 📝
- **Playground**: [LangChain LLM Playground](http://llm.teddynote.com) 🎮
At this base repository, it serves as a home for both beginners and seasoned LangChain users. The tutorial whould provide a roadmap for learning LangChain, while also offering a valuable refresher for those already familiar with its functionalities.

## 🛠️ Contribution Process
### Step
1. **Content Development & Pull Request(PR)**: Create at least **one** existing or new content file (`.ipynb`). Optionally, add examples related to open LLMs. Then, Submit a PR with the developed content.
### Steps (in developing)
1. **Open a Pull request (PR)**: Develop at least **one** existing or new content file (`.ipynb`). Optionally, add examples related to open LLMs. Then, Submit a PR with the developed content.
*- Note: Self-Check Before PR Submission (Recommended)*
- **License Compliance & Copyright Issues**: Verify that all dataset and content comply with licensing requirements. Confirm that there are no copyright infringements.
- **Template Compliance**: Follow the provided [templates](https://github.com/LangChain-OpenTutorial/LangChain-OpenTutorial/tree/main/99-TEMPLATE)
Expand All @@ -35,7 +27,18 @@ This comprehensive resource aims to provide both new and existing users with up-
4. **Merge Pull Request**: Once the Pull Request has been approved by more than two reviewers, the original author can merge the PR into the 'main' branch.
5. **Proofreading**: During the following week, the proofreading team will review the submitted content for typos, template compliance, and proper citations. If the proofreading team requests any modifications, the original author must make the necessary corrections and resubmit the PR.

## 📚 References
- [langchain-ai](https://github.com/langchain-ai/langchain) 📖
- [LangGraph GitHub](https://github.com/langchain-ai/langgraph)
- [LangChain Documentation](https://python.langchain.com/docs/introduction/)
- [OpenAI API Reference](https://platform.openai.com/docs/introduction) 🤖

## 🔗 Community Links
- **LangChain Korean Tutorial(wikidocs)**: [WikiDocs](https://wikidocs.net/book/14314)
- **LangChain Korean Tutorial(github)**: [GitHub Repository](https://github.com/teddylee777/langchain-kr)
- **YouTube Channel**: [Teddy Note](https://www.youtube.com/channel/UCt2wAAXgm87ACiQnDHQEW6Q) 🎥
- **Blog**: [Teddy Note](https://teddylee777.github.io) 📝
- **Playground**: [LangChain LLM Playground](http://llm.teddynote.com) 🎮

### Related Links
- [Dashboard](https://docs.google.com/spreadsheets/d/1Kt7BiKyuAoQeIks1v1V2ii6ri5WJqWZ1fS_oe0z4nsM/edit?gid=1162559766#gid=1162559766)
Expand All @@ -44,6 +47,12 @@ This comprehensive resource aims to provide both new and existing users with up-
- [meeting_1_kickoff](https://drive.google.com/file/d/1TqVonuyda6gnJkdSc-XpsqE6JkTmjquZ/view?usp=drive_link)
- [meeting_2_241228](https://docs.google.com/presentation/d/1xVJXCKV9OC4kQk3VKWL79KHitxcX-Mjj/edit#slide=id.p6)

## Licence

Unless stated otherwise, the codebase is released under the [MIT Licence][1]. This covers both the codebase and any sample code in the documentation.

[1]: ./LICENCE

## 🌟 Contributors
[![Contributors](https://contrib.rocks/image?repo=LangChain-OpenTutorial/LangChain-OpenTutorial&max=5000)](https://github.com/LangChain-OpenTutorial/LangChain-OpenTutorial/graphs/contributors)

Expand Down
Loading