Skip to content

Create and add coding standards to the Contributor's Guide #2361

@jprestop

Description

@jprestop

This is a sub-issue of #2360 (Add content to the Contributor's Guide).

Describe the Sub-Issue

A Contributor's Guide outline was created with the Create outline for a MET Contributor's Guide #1774 issue. We must still create and add coding standards to the MET Contributor's Guide per METplus-Internal Issue 26.

Research whether CLion or some other IDE can automate this process for us.

Two potential requirements:

  • Consider only choosing a standard for which we can use an IDE to automate this process.
  • Only chose a standard for which there is an automated way (GitHub Actions) of checking for compliance.

Recommend getting input from @georgemccabe and @prestopUCAR about using CLion to facilitate this.

Time Estimate

Up to two months of one or more engineer's time

Charge work to FY2025 AF Key, see @michelleharrold

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Metadata

Metadata

Assignees

Type

No type

Projects

Status

🟢 Ready

Relationships

None yet

Development

No branches or pull requests

Issue actions