Dimitrios Philliou
1a74e6d63e
* Refactor README and add host installation guides, governance docs - Reorganized README for clarity and navigation - Added dedicated installation guides for Claude, Cursor, Windsurf, JetBrains, and more - Clarified contribution guidelines and approval criteria - Added policies and governance documentation * Update README.md * Update README with configuration section for remote GitHub MCP Server * Update MCP access policy description in README Removing coding agent from the policy note, as the GitHub server is unaffected by this policy * Update configuration steps for GitHub Copilot in JetBrains IDEs... ...to reflect changes in accessing settings and configuring MCP. * Update install-other-copilot-ides.md * Update Eclipse MCP support version and configuration steps... ...for GitHub Copilot plugin in installation guide. * Update docs/installation-guides/install-cursor.md * Update docs/installation-guides/install-windsurf.md * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg * Apply suggestion from @tonytrg --------- Co-authored-by: Tony Truong <tonytrg@github.com>
3.0 KiB
Contributing
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 to the public under the project's open source license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
What we're looking for
We can't guarantee that every tool, feature, or pull request will be approved or merged. Our focus is on supporting high-quality, high-impact capabilities that advance agentic workflows and deliver clear value to developers.
To increase the chances your request is accepted:
- Include real use cases or examples that demonstrate practical value
- If your request stalls, you can open a Discussion post and link to your issue or PR
- We actively revisit requests that gain strong community engagement (👍s, comments, or evidence of real-world use)
Thanks for contributing and for helping us build toolsets that are truly valuable!
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.
- Install Go through download | through Homebrew
- Install golangci-lint v2
Submitting a pull request
- Fork and clone the repository
- Make sure the tests pass on your machine:
go test -v ./... - Make sure linter passes on your machine:
golangci-lint run - Create a new branch:
git checkout -b my-branch-name - Add your changes and tests, and make sure the Action workflows still pass
- Run linter:
script/lint - Update snapshots and run tests:
UPDATE_TOOLSNAPS=true go test ./... - Update readme documentation:
script/generate-docs
- Run linter:
- Push to your fork and submit a pull request targeting the
mainbranch - 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.
- 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.