Add contributing doc, style guide doc and issue template#102
Merged
Conversation
V00D00-child
changed the title
There was a problem hiding this comment.
Pull Request Overview
Adds baseline project documentation to guide contributors, enforce coding style, and standardize issue submissions.
- Introduces a comprehensive style guide outlining formatting, naming, and organizational rules.
- Provides contributing guidelines describing issue/pr workflows and links to security and release docs.
- Adds a feature-issue template to streamline new feature requests.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/styleGuide.md | New coding style guide for formatting, naming, and best practices. |
| CONTRIBUTING.md | Project contribution guidelines and workflow. |
| .github/ISSUE_TEMPLATE/feature.md | Template for creating new feature issues. |
Comments suppressed due to low confidence (3)
docs/styleGuide.md:15
- [nitpick] The guideline specifies camelCase for file names, which contradicts common JS practices of kebab-case; consider aligning file naming conventions with community standards or clarifying when to use camelCase vs kebab-case.
- Use camelCase for file names
CONTRIBUTING.md:3
- [nitpick] The sentence uses an exclamation mark and includes an article 'the' before the repository name; consider simplifying grammar for clarity, e.g., 'Thank you for contributing to snap-7715-permissions.'
Thank you for your interest in contributing to the `snap-7715-permissions`! Your contributions help make this project better for everyone.
.github/ISSUE_TEMPLATE/feature.md:28
- The placeholder 'xxxx' should be replaced with an example or instructions indicating how to fill out this section, and ensure consistent bullet indentation for the GIVEN/WHEN/THEN lines.
Scenario: xxxx
jeffsmale90
reviewed
Jun 17, 2025
jeffsmale90
left a comment
jeffsmale90
left a comment
Contributor
There was a problem hiding this comment.
Should we have an issue template for bugs?
Co-authored-by: jeffsmale90 <6363749+jeffsmale90@users.noreply.github.com>
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
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.
Add: