[feat] Add contributing guidelines for the directory #139
+159
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jan 13, 2026
Contributor
Author
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_initial_compiled_components.json_file
branch
from
ab02112 to
bcea6b1
Compare
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_contributing_guidelines_for_the_directory
branch
from
19c7ca3 to
2714228
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive contributing guidelines for the component directory feature. It introduces documentation to help community members submit their Streamlit components to the registry.
Changes:
- Added
directory/README.mdwith detailed instructions for submitting components to the directory - Updated
README.mdto reference the new component directory - Updated
CONTRIBUTING.mdto clarify when directory-specific vs. development setup instructions apply, and improved formatting consistency - Modified
.gitignoreto allow.vscode/settings.json(previously ignored) - Added
.vscode/settings.jsonto enable JSON schema validation for component files
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| directory/README.md | New comprehensive guide for component submission with templates, validation rules, and categories |
| README.md | Added section pointing to the component directory documentation |
| CONTRIBUTING.md | Added directory submission guidance and improved Markdown formatting consistency |
| .gitignore | Modified to allow .vscode/settings.json while still ignoring other VSCode files |
| .vscode/settings.json | New VS Code workspace settings for JSON schema validation of component definitions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_contributing_guidelines_for_the_directory
branch
from
2714228 to
d87ab15
Compare
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_initial_compiled_components.json_file
branch
2 times, most recently
from
e3da9d5 to
787b0d6
Compare
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_contributing_guidelines_for_the_directory
branch
2 times, most recently
from
554ec40 to
6ed2fc6
Compare
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_initial_compiled_components.json_file
branch
from
787b0d6 to
4aa9dc7
Compare
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_contributing_guidelines_for_the_directory
branch
from
6ed2fc6 to
8bcfb06
Compare
sfc-gh-bnisco
force-pushed
the
01-13-_feat_add_initial_compiled_components.json_file
branch
from
4aa9dc7 to
08fc508
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TL;DR
Add a community component directory to the repository with JSON schema validation.
What changed?
.gitignoreto allow.vscode/settings.jsonwhile ignoring other VS Code filesWhy make this change?
This change establishes a community-maintained directory of Streamlit components, making it easier for developers to discover and share components. The JSON schema validation ensures consistent formatting and required information for all component submissions, while the documentation provides clear instructions for contributors.