Skip to content

pull request and bug report template #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "\U0001F41B Bug report"
about: Report a bug or unexpected behavior while using GitHub MCP
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
about: Report a bug or unexpected behavior while using GitHub MCP
about: Report a bug or unexpected behavior while using GitHub MCP Server

title: ''
labels: bug
assignees: ''

---

### Describe the bug

A clear and concise description of what the bug is.

### Affected version

Please run `go run cmd/github-mcp-server/main.go --version` and paste the output below.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).


### Steps to reproduce the behavior

1. Type this '...'
2. View the output '....'
3. See error

### Expected vs actual behavior

A clear and concise description of what you expected to happen and what actually happened.

### Logs

Paste any available logs. Redact if needed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Paste any available logs. Redact if needed.
Paste any available logs. Redact if needed.

11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--
Thank you for contributing to GitHub MCP!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Thank you for contributing to GitHub MCP!
Thank you for contributing to GitHub MCP Server!

Please reference an existing issue: `Closes #NUMBER`

Screenshots or videos of changed behavior is incredibly helpful and always appreciated.
Consider addressing the following:
- Tradeoffs: List tradeoffs you made to take on or pay down tech debt.
- Alternatives: Describe alternative approaches you considered and why you discarded them.
-->

Closes:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Closes:
Closes: