[PR #829] [CLOSED] docs: add CONTRIBUTING.md with submission checklist #10289

New Issue

GiteaMirror · 2026-06-12T10:52:31-05:00

GiteaMirror commented

2026-06-12 10:52:31 -05:00

📋 Pull Request Information

Original PR: https://github.com/Shubhamsaboo/awesome-llm-apps/pull/829
Author: @Alexi5000
Created: 5/21/2026
Status: ❌ Closed

Base: main ← Head: pr/add-contributing-guide

📝 Commits (1)

919324d docs: add CONTRIBUTING.md with submission checklist

📊 Changes

1 file changed (+125 additions, -0 deletions)

View changed files

➕ CONTRIBUTING.md (+125 -0)

📄 Description

Summary

Adds a CONTRIBUTING.md with clear guidelines for submitting new templates
Includes directory structure conventions, requirements.txt best practices (version pinning, no stdlib modules), API key handling patterns, README template, and a PR checklist
Aligned with the repo's existing patterns (Streamlit sidebar for keys, self-contained directories)

Motivation

The repo has 111K+ stars and active contributions but no contributing guide. New contributors don't know the expected directory structure, whether to pin deps, or how to handle API keys. This doc codifies the patterns already established by the best templates in the repo.

Test plan

Review CONTRIBUTING.md for accuracy against existing repo conventions
Verify directory structure guidance matches actual category layout
Confirm PR checklist covers common submission issues

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Shubhamsaboo/awesome-llm-apps/pull/829 **Author:** [@Alexi5000](https://github.com/Alexi5000) **Created:** 5/21/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `pr/add-contributing-guide` --- ### 📝 Commits (1) - [`919324d`](https://github.com/Shubhamsaboo/awesome-llm-apps/commit/919324ddee17aba4bed8a2ecaaaddf9355f49f0f) docs: add CONTRIBUTING.md with submission checklist ### 📊 Changes **1 file changed** (+125 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `CONTRIBUTING.md` (+125 -0) </details> ### 📄 Description ## Summary - Adds a `CONTRIBUTING.md` with clear guidelines for submitting new templates - Includes directory structure conventions, `requirements.txt` best practices (version pinning, no stdlib modules), API key handling patterns, README template, and a PR checklist - Aligned with the repo's existing patterns (Streamlit sidebar for keys, self-contained directories) ## Motivation The repo has 111K+ stars and active contributions but no contributing guide. New contributors don't know the expected directory structure, whether to pin deps, or how to handle API keys. This doc codifies the patterns already established by the best templates in the repo. ## Test plan - [ ] Review CONTRIBUTING.md for accuracy against existing repo conventions - [ ] Verify directory structure guidance matches actual category layout - [ ] Confirm PR checklist covers common submission issues --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-06-12 10:52:31 -05:00

GiteaMirror closed this issue

2026-06-12 10:52:32 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/awesome-llm-apps#10289