Searchcraft MCP Server

# Contributing to `searchcraft-mcp-server` All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: > - Follow [Searchcraft](https://github.com/searchcraft-inc) on GitHub > - Star the repository > - Mention the Searchcraft MCP server at local meetups and tell your friends/colleagues ## Code of Conduct This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [support@searchcraft.io](mailto:support@searchcraft.io). ## Preferred Language We prefer all communication to be in English. ## I Have a Question > If you want to ask a technical question, we assume that you have read the project's [README](./README.md) and our [tech documentation](https://docs.searchcraft.io/). We recommend the following: - Provide as much context as you can about what you're running into. - Provide project and platform versions, depending on what seems relevant. ## I Want To Contribute > ### Legal Notice > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. For PRs will ask you to accept the [Contributor License Agreement](./CLA.md). ### Reporting Bugs #### Before Submitting a Bug Report A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. - Make sure that you are using the latest version. - Determine if your bug is really a bug and not an error on your side e.g. using an incompatible platform version, environment, etc. - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a Github issue created for your bug in the [issue tracker](https://github.com/searchcraft-inc/searchcraft-issues/issues?q=label%3Abug). #### How Do I Submit an Issue? > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [support@searchcraft.io](support@searchcraft.io) (please see our [security policy](https://github.com/searchcraft-inc/searchcraft-issues/blob/main/SECURITY.md) for details). If you run into an issue with the project: - Open an [Issue](https://github.com/searchcraft-inc/searchcraft-issues/issues/new/choose) in the [Searchcraft Issues](https://github.com/searchcraft-inc/searchcraft-issues/issues) repository. - Click `Bug report` - Explain the behavior you would expect and the actual behavior. - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. - Provide the information you collected in the previous section. Once it's filed: - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. - If the team is able to reproduce the issue and the issue will be left to be addressed by the team or contributors. ### Requesting Features #### Before Requesting a Feature - Make sure that you are using the latest version. - To see if other users already requested something similar you are suggesting, check the [tracker](https://github.com/searchcraft-inc/searchcraft-issues/issues?q=label%3Aenhancement). #### How Do I Submit a Good Enhancement Suggestion? Enhancement suggestions are tracked as [GitHub issues](https://github.com/searchcraft-inc/searchcraft-issues/issues/new/choose). - Open an [Issue](https://github.com/searchcraft-inc/searchcraft-issues/issues/new/choose) - Click `Feature request` - Follow the template and feel free to add more details ### Contributing Code When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. Our bot will ask you to accept the [Contributor License Agreement](./CLA.md) before we can accept the pull request. Basic rules for pull requests: - Pull requests generally need to be based on and opened against the `develop` branch, unless by explicit agreement. - Please follow our suggested template for the pull request description. - Major functionality changes should be proposed through issue discussion prior to contribution. All pull requests will be reviewed by the maintainer team.