ci(issue-template): create Website issue template - #1108
Conversation
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, you can find updates in the #github-notifications channel in the community Slack. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a GitHub issue template for website-related reports. The template includes metadata, behavior prompts, optional screenshots or logs, and contributor resource links. ChangesWebsite issue reporting
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/ISSUE_TEMPLATE/website.md:
- Line 9: Update the top-level section headings in the website issue template,
including “Current Behavior” and the peer sections at the referenced locations,
from level-3 headings to level-2 headings so the template hierarchy is
consistent and satisfies MD001.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 5245efa7-8f52-4cb7-a21c-b89377fc720b
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/website.md
Maanvi212006
left a comment
There was a problem hiding this comment.
Went through this end to end (diff, content, labels config, and checked live labels on GitHub) — LGTM overall.
One thing to fix before merge: the template uses area/website as a label, but that label doesn't actually exist in the repo yet. Right now it'll just silently not get applied when someone files an issue. Could we create it first, or use an existing label instead?
|
@Maanvi212006 Thanks for catching that! If we have to use a pre-existing label here, I think |
|
@AnkitRewar11 maybe we can introduce a new label dedicated to website. |
|
@Maanvi212006 I lean towards using |
|
Sounds good! I'll update the label to |
Signed-off-by: Ankit Rewar <AnkitRewar11@users.noreply.github.com>
c8c440d to
839e643
Compare
|
@ishwar170695 Hello, good morning! Please, whenever you have time, take a look at this. Have a nice day! 🙌 |
| name: 🌐 Website issue | ||
| about: Issues related to website. | ||
| title: '[Website]' | ||
| labels: 'area/docs, framework/jekyll' |
There was a problem hiding this comment.
Docs?
Perhaps, a new dedicated label is needed.
There was a problem hiding this comment.
Sir, I had initially suggested using area/website, as you can see in the earlier conversation above. However, I later changed it to area/docs. Although area/website was a new label, after our discussion I felt that area/docs was the most appropriate choice, so I updated it accordingly.
|
LGTM! |
|
Hey, could you please have a look when you get some time and let me know if there are any other changes needed? Otherwise, I think everything looks good. @banana-three-join |
banana-three-join
left a comment
There was a problem hiding this comment.
I don't agree with the area/docs label. There's currently a docs folder and a documentation.md template which already uses the 'area/docs, framework/jekyll, language/markdown' labels so there needs to be a bigger differentiator between the two of them to have a better track of the issues.
You can use something like area/site since that's the folder where the main logic for https://schemas.meshery.io/ resides.
|
I also agree with your point about using the Area/Site label. However, @ishwar170695 and @Maanvi212006 suggested that since this is a new label, using Area/Docs would be more appropriate. That said, we can go with Area/Site if you think that’s better. I’ll push a new commit with the Area/Site label. @banana-three-join |
|
I did see both of their points and while I do think they're right, I also think that applying a placeholder label in the meanwhile because there isn't another label available, isn't the preferred approach. Let me go take a look at to how the other repos do it so I can comeback with a more conclusive answer. Thanks to both of you for helping out over in this area! @Maanvi212006 @AnkitRewar11 |
Notes for Reviewers
This PR fixes #1098
This PR creates a dedicated "Website" GitHub issue template (
.github/ISSUE_TEMPLATE/website.md) forschemas.meshery.io, following the repository's casing rules and issue template conventions.Changes Included
.github/ISSUE_TEMPLATE/website.mdwith[Website]title prefix andarea/website,framework/jekylllabels.Signed commits
Summary by CodeRabbit