CONTRIBUTING.md

☝️ Please Note!

This plugin was integrated into CLion 2019.1, and it will be further developed as part of the IDE. Older versions of the plugin will remain available in the plugins repository.

Refer to the press release for more information.

For bug reports and feature requests, please use JetBrains YouTrack. Feel free to upvote and comment in existing tickets.

This repository was archived and turned read-only.

This contribution guide is for reference purposes only.

---

How to contribute to clion-embedded-arm plugin

Did you find a bug?

• Ensure the bug was not already reported by searching on GitHub under Issues.

• If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

• Please note your platform (linux, windows, mac), CLion version, OpenOCD version, STM32CubeMX version (if applicable), type of your MCU and/or development board

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

See above. Please note that formatting fixes may merged, or may be rejected without any explanations.

Do you intend to add a new feature or change an existing one?

• Open an issue on GitHub, add feature request label to it.

Do you have questions about the source code?

• Open an issue on GitHub, add question label to it.

Do you want to contribute to the documentation?

This is the best contribution to the project. Go right ahead, open a pull request! You can do it online

Thanks! 💓

Elmot