Skip to content

Code style guide for kernels#145

Merged
Steve Mullerworth (stevemullerworth) merged 11 commits intoMetOffice:mainfrom
andrewcoughtrie:code-style-guide-for-kernels
Aug 12, 2025
Merged

Code style guide for kernels#145
Steve Mullerworth (stevemullerworth) merged 11 commits intoMetOffice:mainfrom
andrewcoughtrie:code-style-guide-for-kernels

Conversation

@andrewcoughtrie
Copy link
Copy Markdown
Collaborator

@andrewcoughtrie Andrew Coughtrie (andrewcoughtrie) commented Aug 5, 2025 •
edited
Loading

Description

Added code style guide for LFRic kernels. This is basic information for developers and reviewers to aid in maintaining proper coding standards within kernels, links are provided to the more comprehensive information in the PSyclone documentation.

Linked issues

Closes #98

Developer tags

Type of change

  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

  • New tests have been added.
  • Tests have been modified to accommodate this change.
  • GitHub workflows have been changed or added.

Checklist:

  • The change has been checked for design compliance by an experienced SSE
  • My code follows the style guidelines of this project.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes, for both debug and optimised builds.
  • No AI tools have been used in the creation of this change.

Reasoning on why any of the above boxes have not been checked

Review Checks (To be filled in by the reviewer/s)

  • Has the developer completed the appropriate sections above?
  • Is the change compliant with LFRic Core principles?
  • Is the testing coverage sufficient?
  • Have any technical debt workarounds identified had issues opened and interested parties notified?

@andrewcoughtrie Andrew Coughtrie (andrewcoughtrie) marked this pull request as ready for review August 5, 2025 15:21
Closed
stevemullerworth
Steve Mullerworth (stevemullerworth) requested changes Aug 5, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@stevemullerworth Steve Mullerworth (stevemullerworth) left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few style and grammar comments.

stevemullerworth
Steve Mullerworth (stevemullerworth) previously approved these changes Aug 6, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@stevemullerworth Steve Mullerworth (stevemullerworth) left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made two suggestions. I got the impression the pull request can be merged by you if you accept them without change...

@andrewcoughtrie @stevemullerworth
Apply suggestions from code review
6cbd153 
Co-authored-by: Steve Mullerworth <steve.mullerworth@metoffice.gov.uk>
stevemullerworth
Steve Mullerworth (stevemullerworth) previously requested changes Aug 6, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@stevemullerworth Steve Mullerworth (stevemullerworth) left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Managed to lose the bullet point in my previous suggestion :-(

@andrewcoughtrie @stevemullerworth
Update documentation/source/how_to_contribute/coding_standards/fortra…
b4af94b 
…n_coding_standards.rst

Co-authored-by: Steve Mullerworth <steve.mullerworth@metoffice.gov.uk>
mike-hobson
Mike Hobson (mike-hobson) approved these changes Aug 12, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@mike-hobson Mike Hobson (mike-hobson) left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved for Steve

@stevemullerworth Steve Mullerworth (stevemullerworth) merged commit ec8e900 into MetOffice:main Aug 12, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mike-hobson Mike Hobson (mike-hobson) mike-hobson approved these changes

@mo-lucy-gordon mo-lucy-gordon mo-lucy-gordon approved these changes

@mo-rickywong Ricky Wong (mo-rickywong) mo-rickywong approved these changes

@stevemullerworth Steve Mullerworth (stevemullerworth) stevemullerworth left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Documentation]: Add info to code style guide for Kernels

5 participants

@andrewcoughtrie @stevemullerworth @mike-hobson @mo-lucy-gordon @mo-rickywong