- Notifications
You must be signed in to change notification settings - Fork949
docs: add oss documentation#21
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| @juruen @sammorrowdrums @williammartin @toby |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| ## Contributing | ||
| [fork]: https://github.com/github/github-mcp-server/fork | ||
| [pr]: https://github.com/github/github-mcp-server/compare | ||
| [style]: https://github.com/github/github-mcp-server/blob/main/.golangci.yaml | ||
| Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
| Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt). | ||
| Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
| ## Prerequisites for running and testing code | ||
| These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process. | ||
| 1. install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go) | ||
| 1. [install golangci-lint](https://golangci-lint.run/welcome/install/#local-installation) | ||
| ## Submitting a pull request | ||
| 1. [Fork][fork] and clone the repository | ||
| 1. Make sure the tests pass on your machine: `go test -v ./...` | ||
| 1. Make sure linter passes on your machine: `golangci-lint run` | ||
| 1. Create a new branch: `git checkout -b my-branch-name` | ||
| 1. Make your change, add tests, and make sure the tests and linter still pass | ||
| 1. Push to your fork and [submit a pull request][pr] | ||
| 1. Pat yourself on the back and wait for your pull request to be reviewed and merged. | ||
| Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
| - Follow the [style guide][style]. | ||
| - Write tests. | ||
| - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
| - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
| ## Resources | ||
| - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||
| - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) | ||
| - [GitHub Help](https://help.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| Thanks for helping make GitHub safe for everyone. | ||
| # Security | ||
| GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub). | ||
| Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation. | ||
| ## Reporting Security Issues | ||
| If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure. | ||
| **Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** | ||
| Instead, please send an email to opensource-security[@]github.com. | ||
| Please include as much of the information listed below as you can to help us better understand and resolve the issue: | ||
| * The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting) | ||
| * Full paths of source file(s) related to the manifestation of the issue | ||
| * The location of the affected source code (tag/branch/commit or direct URL) | ||
| * Any special configuration required to reproduce the issue | ||
| * Step-by-step instructions to reproduce the issue | ||
| * Proof-of-concept or exploit code (if possible) | ||
| * Impact of the issue, including how an attacker might exploit the issue | ||
| This information will help us triage your report more quickly. | ||
| ## Policy | ||
| See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Support | ||
| ## How to file issues and get help | ||
| This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue. | ||
| For help or questions about using this project, please open an issue. | ||
| - The `github-mcp-server` is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner. | ||
| ## GitHub Support Policy | ||
| Support for this project is limited to the resources listed above. |
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.