Skip to content
This repository has been archived by the owner on Sep 28, 2019. It is now read-only.

Latest commit

 

History

History
47 lines (28 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 2.63 KB
Raw

All contributions are highly appreciated!

There are many ways you can contribute to this project, and all contributions are highly appreciated.

Post your findings & questions

If you have interesting use cases, if you have custom configurations, and generally if you have any experience that you want to share with others, please use the GNU ARM Eclipse forum.

Just register to element14 community and use the Start a discussion link.

Submit bug reports & enhancement requests

If you are convinced you identified a bug (if you have doubts, use the forum), or you have a pertinent suggestion how to enhance the GNU MCU Eclipse OpenOCD, please use the GitHub Issues tracker.

Be sure you report only issues related to the GNU MCU Eclipse OpenOCD. DO NOT use it for issues related to the plug-ins or the other tools (QEMU, OpenOCD, etc), which should be addressed to their corresponding trackers. Web content issues should be addressed to the Web Issues tracker. J-Link specific questions should be addresses to SEGGER support.

Before reporting issues, please check the list of Known Issues and the FAQ.

When entering a new issue, be sure you provide:

  • OpenOCD package version
  • Eclipse version
  • Java version
  • operating system (sorry, no requests for Win XP 64)
  • toolchain version
  • the detailed and complete list of steps to reproduce the bug (mandatory)

Please understand that without being able to reproduce the bug we cannot identify your problem.

To be allowed to enter issues, you need first to login to GitHub.

Note: the text should respect the markdown syntax; preview the message before posting and correct if it does not look as expected, especially inline code or other quoted text.

Submit pull requests

The most useful contribution to the project is to submit code. GitHub greatly simplifies this process, by using pull requests.

For those not familiar with GitHub workflow, reading the official Using pull requests page can be of great help.

In short, the process is something like this:

  • fork the Git repository to your own account
  • create a custom branch
  • make the desired changes
  • commit to the custom branch
  • submit the pull request