Skip to content

fix: add Python coding standards info #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 6, 2024
Merged

fix: add Python coding standards info #1686

merged 6 commits into from
Sep 6, 2024

Conversation

degenaro
Copy link
Collaborator

@degenaro degenaro commented Sep 5, 2024

Types of changes

  • Hot fix (emergency fix and release)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation (change which affects the documentation site)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Release (develop -> main)

Quality assurance (all should be covered).

  • My code follows the code style of this project.
  • Documentation for my change is up to date?
  • My PR meets testing requirements.
  • All new and existing tests passed.
  • All commits are signed-off.

Summary

Key links:

Before you merge

  • Ensure it is a 'squash commit' if not a release.
  • Ensure CI is currently passing
  • Check sonar. If you are working for a fork a maintainer will reach out, if required.

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

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

A similar section exists here - https://github.com/oscal-compass/compliance-trestle/blob/coding-standard/CONTRIBUTING.md#code-style-and-formating. Perhpas that could be refined instead of adding a new section.

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Copy link
Member

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

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

LGTM

@degenaro degenaro requested a review from jpower432 September 6, 2024 09:54
Inspired by need to address OpenSSF requirement:

To enable collaborative review, the project's source repository MUST
include interim versions for review between releases; it MUST NOT
include only final releases.

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Copy link
Member

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

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

LGTM

@degenaro degenaro merged commit 1fe8457 into develop Sep 6, 2024
14 checks passed
@degenaro degenaro deleted the coding-standard branch September 6, 2024 19:47
d10n pushed a commit to d10n/compliance-trestle that referenced this pull request Apr 30, 2025
* Add Python coding standards info

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>

* correct english

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>

* address reviewer suggestion on PEP8 link location

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>

* Trestle updating and release logistics

Inspired by need to address OpenSSF requirement:

To enable collaborative review, the project's source repository MUST
include interim versions for review between releases; it MUST NOT
include only final releases.

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>

* Fix contributing copyright.

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>

* add semantic release & tags info

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>

---------

Signed-off-by: Lou DeGenaro <lou.degenaro@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants