Ceedling icon indicating copy to clipboard operation
Ceedling copied to clipboard

Add Cppcheck plugin

Open deltalejo opened this issue 2 years ago • 7 comments

I made a plugin to run Cppcheck analysis as Ceedling tasks. I think it is a very useful plugin that promotes using static anlysis tools for embedded software development. I'm open to feedback.

deltalejo avatar Apr 27 '23 19:04 deltalejo

@deltalejo -- thanks for working on this! I am very happy to see this feature added and I appreciate your work!

mvandervoord avatar Apr 27 '23 19:04 mvandervoord

You are welcome to host this plugin yourself, as you have it now. If at any point you decide you'd rather have it part of the main Ceedling project, we can do that too. I don't want to take credit for your work or anything (we should find a way to give good credit for submitted plugins. Certainly in the plugin readme... maybe something else too?). I'm just interested in making it easy for people to install, etc.

mvandervoord avatar Apr 27 '23 19:04 mvandervoord

It would be great if the plugin gets included in Ceedling, just let me know how to proceed. I can add an AUTHORS file to plugin sources if that's OK.

deltalejo avatar Apr 27 '23 19:04 deltalejo

Having interacted with @deltalejo before on a different plugin, I would love for the Cppcheck plugin to be added into Ceedling. I'm already using it regularly and it's fantastic. Definitely should find a way to acknowledge authors/contributors. Here's some ideas that come to mind:

  • Maintaining a section in the README listing all contributors along with their contributions. This can be manually updated or automated using tools like all-contributors.
  • Creating a separate CONTRIBUTORS.md file that lists all the contributors and their contributors. Could be linked from the README for visibility. This could be placed in the docs folder.
  • Once v0.32 is released, maybe including a section in the release notes that credits contributors for their work?

tyler-macinnis avatar Aug 09 '23 11:08 tyler-macinnis

@tyler-macinnis We're making progress on recognizing contributors appropriately. The new ReleaseNotes.md in docs/ has a significant section towards the top attempting to do so as a first step. Your other suggestions are good ones. We're motivated to clean up and better structure processes and documentation. As we continue to do so, we'll be sure to give some attention to recognizing and documenting contributors.

mkarlesky avatar Jun 25 '24 14:06 mkarlesky

@deltalejo A good static analysis plugin is a great addition to the project. We probably won't be able to incorporate it into the next significant release, but I'd like to at minimum slate this for the next point release. We are transitioning to packaging and final release work, including much improved Docker images for Ceedling and plugin tools. I'll make sure we're in a good place for adding Cppcheck to the Docker images for future updates.

mkarlesky avatar Jun 25 '24 14:06 mkarlesky

@mkarlesky I'm always glad to contribute to this awesome project. Let me know if you have in mind some steps you want me to take on this plugin so it is included in a near future.

deltalejo avatar Jun 25 '24 16:06 deltalejo