OpenThread released by Google is an open-source project. Use the following resources if you need help using, or contributing to, OpenThread. ## Interact ### Community forum Use [OpenThread Github Discussions](https://github.com/orgs/openthread/discussions) to discuss OpenThread and ask questions. This is the best place to get direct feedback from the OpenThread team. ### Bugs and feature requests If you discover a code bug or have a request for an enhancement, please submit it to the Issue Tracker in each respective GitHub repository: - [OpenThread](https://github.com/openthread/openthread/issues) - [OpenThread Border Router](https://github.com/openthread/ot-br-posix/issues) - [OpenThread Commissioner](https://github.com/openthread/ot-commissioner/issues) - [OpenThread Network Simulator](https://github.com/openthread/ot-ns/issues) - [OpenThread Registrar](https://github.com/openthread/ot-registrar/issues) - [OpenThread RTOS](https://github.com/openthread/ot-rtos/issues) - [Pyspinel](https://github.com/openthread/pyspinel/issues) - [Silk](https://github.com/openthread/silk/issues) If you'd like to contribute to OpenThread Guides, Codelabs, or API Reference Topics, refer to [CONTRIBUTING](https://github.com/openthread/openthread/CONTRIBUTING.md) in the GitHub repo. You can also use the **Send Feedback** button found in the upper-right of every site page. ## Contribute We would love for you to contribute to OpenThread and help make it even better than it is today! Contributing includes both documentation and code suggestions. See the [Contribution Guidelines](https://github.com/openthread/openthread/tree/master/CONTRIBUTING.md) on GitHub for more information. ### Documentation contributions There are two types of OpenThread documentation: - GitHub --- focuses on setup, how to build example platforms, how to use tools - openthread.io --- focuses on OpenThread news and features, use cases, guides, API reference When contributing to the OpenThread GitHub repository directly, add documentation in the form of READMEs as part of your pull request. For example, if you port OpenThread to a new hardware platform, include a README explaining how to build OpenThread on that platform. A good example is the [Qorvo GP712 platform addition](https://github.com/openthread/openthread/pull/1942). If you would like to contribute to openthread.io, please submit an issue to the [Issue Tracker](https://github.com/openthread/openthread/issues), explaining your proposed contribution. A member of the OpenThread team will work with you to get your content added to the site. Examples of openthread.io contributions would be an article about using OpenThread in manufacturing, or a vendor providing detailed deployment instructions for one of their platforms. Note: All documentation contributions should follow the [Google Developer Documentation Style Guide](https://developers.google.com/style/).
## Featured Product and Supporter Guidelines ### Products Featured products use OpenThread and support the core requirements of the Thread Specification. Examples of how product images are used are available at [OpenThread Products](https://openthread.io/products.md.txt). If your product uses OpenThread and you want it to be included in our featured products, we'll need the following items: 1. The product image should be rectangular, with a minimum resolution of 705x395. Larger images are acceptable as long as the ratio (1.78:1) is kept. Additionally, the background should be transparent. For example, this image meets our requirements: ![Example featured product image](https://openthread.io/images/ot-product-nest-hub-max.png) 2. The description should focus solely on the product's functionality and be less than 140 characters otherwise it might be truncated in certain presentations. 3. Provide the product name, an external product link, and whether it's Built on Thread / Certified. 4. Send your product listing request and required assets to [openthread-product-listing@google.com](mailto:openthread-product-listing@google.com). For example: - *Product name/title:* Google Nest Hub Max - *URL:* https://store.google.com/product/google_nest_hub_max - *Description:* Get help, connect with those who matter most, and control your connected home in one view. - *Image:* See the example product image above. > [!NOTE] > **Note:** Products featured in our listing must be products that are released and available for purchase by consumers. ### Supporters and Company Logos Similar to product imagery, logos need a minimum resolution of 400x225. Bigger is okay but keep the same ratio of 1.78:1. The logo should ideally span the full horizontal width. Use the PNG format and ensure the background is transparent. See the current [Who supports OpenThread?](https://openthread.io#who-supports-openthread) for examples. Also, logos are resized and used on the OpenThread [GitHub README](https://github.com/openthread/openthread/blob/main/README.md). ### OpenThread maintenance of featured product listings The OpenThread team will periodically review all product listings to make sure each featured product is still generally available. If a product has become obsolete, the OpenThread team may remove the product from the featured products list. If a product has been replaced by a newer model, the OpenThread team may update any images and links accordingly. ## OpenThread Brand Guidelines OpenThread, released by Google, is an open-source implementation of Thread®. OPENTHREAD and THREAD are trademarks owned by the Thread Group. Google uses these marks under a license from the Thread Group. We appreciate your use of the OpenThread software and kindly request that you follow the brand guidelines below. - Please use "OpenThread" and "Thread" as an adjective. Do not use "OpenThread" or "Thread" as a verb or a noun. - Correct: The OpenThread software - Incorrect: I need to implement OpenThread - Incorrect: The software threads together different implementations - Always use OpenThread as a unitary word. - Do not abbreviate or alter the OpenThread trademark in any way. - Capitalize the letters "O" and "T" in OpenThread, even if it appears mid-sentence. - If you're using the stylized version of the OpenThread trademark, please use the correct stylization (shown below). ![OpenThread Trademark](https://openthread.io/static/images/ot-logo-narrow.png) - If you're using the OpenThread trademark, include a trademark attribution stating that "OPENTHREAD and related marks are trademarks of the Thread Group." ### Marketing Assets OpenThread logotypes are available for use in print or web materials. Please only use the OpenThread name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Google, Google Nest, or The Thread Group. [Download OpenThread Logotypes](https://openthread.io/static/resources/OpenThread_logotypes.zip)