pull request and bug report template #84
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a pull request template and a bug report template to standardize contribution guidelines and bug reporting for GitHub MCP.
- Added a pull request template with contributor instructions and a placeholder for issue references.
- Introduced a bug report template outlining the steps to describe bugs, version information, and logs.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/pull_request_template.md | New template file providing guidelines for submitting PRs. |
| .github/ISSUE_TEMPLATE/bug_report.md | New bug report template to standardize bug submission details. |
Comments suppressed due to low confidence (2)
.github/pull_request_template.md:11
- [nitpick] The 'Closes:' placeholder might benefit from an example format (e.g., 'Closes Issue: Fix incorrect VS Code installation URL (both buttons point to Insiders) #123') to better guide contributors when referencing issues.
Closes:
.github/ISSUE_TEMPLATE/bug_report.md:20
- [nitpick] Consider providing clearer placeholder instructions in the steps to reproduce (e.g., what should be typed) to improve reporter clarity.
1. Type this '...'
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
There was a problem hiding this comment.
Thanks for this, I'm super happy we are doing this in time for the release! ❤️
One actual comment with the version command. As written it won't give anything useful, and we'd rather they ran it from the pre-built binary if they were using one.
One suggestion is get them to run docker build and then a docker run command. That could work. (example in the Dockerfile plus the branch_name passed as version build arg in the docker workflow.
2 Smol Nits:
- missing line endings at end if file
- I like using the full title and not emitting server because I guess I can be a pedant 🤣
|
|
||
| ### Logs | ||
|
|
||
| Paste any available logs. Redact if needed. |
There was a problem hiding this comment.
| Paste any available logs. Redact if needed. | |
| Paste any available logs. Redact if needed. | |
| - Alternatives: Describe alternative approaches you considered and why you discarded them. | ||
| --> | ||
|
|
||
| Closes: |
There was a problem hiding this comment.
| Closes: | |
| Closes: | |
| @@ -0,0 +1,11 @@ | |||
| <!-- | |||
| Thank you for contributing to GitHub MCP! | |||
There was a problem hiding this comment.
| Thank you for contributing to GitHub MCP! | |
| Thank you for contributing to GitHub MCP Server! |
|
|
||
| ### Affected version | ||
|
|
||
| Please run `go run cmd/github-mcp-server/main.go --version` and paste the output below. |
There was a problem hiding this comment.
Might be worth a first suggestion of running the version flag against docker image or the binary first, as then they'll have the built in version tag.
The command as written will just show the placeholders. It needs to be build with ldflags in order to have real info replace it (see the build command in docker image).
| @@ -0,0 +1,30 @@ | |||
| --- | |||
| name: "\U0001F41B Bug report" | |||
| about: Report a bug or unexpected behavior while using GitHub MCP | |||
There was a problem hiding this comment.
| about: Report a bug or unexpected behavior while using GitHub MCP | |
| about: Report a bug or unexpected behavior while using GitHub MCP Server |
Closes #62
Inspired by and heavily borrowed from https://github.com/cli/cli and other GitHub projects