Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.31 KB
Raw

How to contribute

Thank you for your interest in contributing! While this project originated at InterSystems, it is our hope that the community will continue to extend and enhance it. Our priority is to add and enhance features to meet our internal and general use cases. We do not intend to provide adapters to other code coverage reporting tools and formats, but if you make one, please do share it with the community!

Submitting changes

If you have made a change that you would like to contribute back to the community, please send a GitHub Pull Request explaining it. If your change fixes an issue that you or another user reported, please mention it in the pull request. You can find out more about pull requests here.

Coding conventions

Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:

  • Do not use shortened command and function names - e.g., s instead of set, $p instead of $piece
  • One command per line
  • Do not use dot syntax
  • Indentation with tabs
  • Pascal case class and method names
  • Avoid using postconditionals
  • Local variables start with t; formal parameter names start with p
  • Always check %Status return values

Thanks, Tim Leavitt, InterSystems Corporation