Skip to content

youznn/oss_contributing_helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“Œ ์ถœ์ฒ˜

์ด ํ”„๋กœ์ ํŠธ๋Š” ๋‹ค์Œ ์˜คํ”ˆ์†Œ์Šค ํ”„๋กœ์ ํŠธ์˜ ๋ฐ์ดํ„ฐ๋ฅผ ์ฐธ๊ณ ํ•˜์˜€์Šต๋‹ˆ๋‹ค:

์ƒ๊ธฐ ํ”„๋กœ์ ํŠธ๋Š” MIT ๋ผ์ด์„ ์Šค๋ฅผ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.

โœจ Project Motivation

Open source projects thrive on public collaboration. By opening up source code and inviting developers from around the world to contribute, we create better software and foster a healthy, sustainable developer culture. For individual developers, contributing to open source provides valuable opportunities to learn, communicate, and grow.

However, many developers hesitate to contribute because:

they donโ€™t know how to start,

they donโ€™t know which issue to contribute to, or

theyโ€™re intimidated by the process.

This project, Open Source Contributing Assistant, aims to solve these problems and help activate the open source community.

๐Ÿ› ๏ธ Problem weโ€™re Solving

Many developers are interested in contributing to GitHub open source projects. However, they often:

struggle to identify which issues they can contribute to, and

find it hard to understand contribution guides, which are usually written in English.

Even tools like GitHub Copilot or ChatGPT frequently fail to answer project-specific questions or give proper guidance when asked about contributing (see screenshots above ๐Ÿ‘†).

Open Source Contributing Assistant is a chatbot-based tool that helps users discover suitable open source issues and guides them through contributing.

๐ŸŒŸ Key User Experience & Features

Example queries:

๐Ÿค” โ€œRecommend some beginner-friendly open source issues.โ€ ๐Ÿค” โ€œShow me JavaScript-based issues I can contribute to.โ€ ๐Ÿค” โ€œWhat are the coding conventions for this project?โ€ ๐Ÿค” โ€œI want to help with documentation. Any good issues?โ€

๐Ÿ‘ฉโ€๐Ÿ’ป For Contributors:

๐Ÿ“Œ โ€œI donโ€™t know which issue to work onโ€ โ†’ Get tailored issue recommendations.

๐Ÿ“Œ โ€œContribution guides are confusingโ€ โ†’ Get summaries and chatbot help.

๐Ÿจ For Open Source Maintainers:

๐Ÿ“Œ โ€œWe organized our issues, but new contributors arenโ€™t joiningโ€โ†’ Boost project exposure and lower entry barriers with guided onboarding.

๐Ÿš€ Core Features

๐Ÿค– ChatBot

Recommends open source issues based on:

Programming language

Tags (e.g., documentation, bug, good first issue)

Difficulty level

Summarizes the repository (via README.md)

Explains issue goals in simple terms

Supports general and project-specific Q&A

Checks community health files (e.g., CODE_OF_CONDUCT.md) via sidebar

๐Ÿ“‹ Repository Dashboard

Project overview summarization

Contribution guide summary (contributing.md)

Readme summary (readme.md)

Uses LLM to simplify complex documentation

๐Ÿ“š Data & Technology

  1. Vector Database

Datasets:

Good First Issues

Awesome for Beginners

These datasets are JSON-formatted and updated regularly. Licensed under MIT, they are free to use with attribution.

Using: ChromaDB

Stores both vector and metadata

Allows metadata-based filtering

Lightweight and efficient for small-scale queries

  1. GitHub REST API

Collects repository and issue data using the GitHub Search API

  1. Filtering Criteria

Uses standardized GitHub issue tags:

good first issue โ†’ beginner-friendly

docs โ†’ documentation-related

  1. LangGraph

Enables modular, reusable, and traceable flow control

Supports branching logic and state-based logging

About

with AzureOpenAI, ChromaDB, LangGraph

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages