Skip to content
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

feat(RHINENG-5460): Add rh-pre-commit installation instructions to README #1576

Merged
merged 3 commits into from
Dec 11, 2023

Conversation

kruai
Copy link
Collaborator

@kruai kruai commented Dec 7, 2023

Overview

This PR is being created to address RHINENG-5460.
It adds a note to our Contributing section instructing users to install rh-pre-commit before contributing. I specified that this only applies if you're on the RH network, because rh-pre-commit only works when you're on the VPN.

PR Checklist

  • Keep PR title short, ideally under 72 characters
  • Descriptive comments provided in complex code blocks
  • Tests: validate optimal/expected output
  • Tests: validate exceptions and failure scenarios
  • Tests: edge cases
  • Recovers or fails gracefully during potential resource outages (e.g. DB, Kafka)
  • Uses type hinting, if convenient
  • Documentation, if this PR changes the way other services interact with host inventory
  • Links to related PRs

Secure Coding Practices Documentation Reference

You can find documentation on this checklist here.

Secure Coding Checklist

  • Input Validation
  • Output Encoding
  • Authentication and Password Management
  • Session Management
  • Access Control
  • Cryptographic Practices
  • Error Handling and Logging
  • Data Protection
  • Communication Security
  • System Configuration
  • Database Security
  • File Management
  • Memory Management
  • General Coding Practices

@kruai kruai requested a review from a team as a code owner December 7, 2023 15:19
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kruai kruai requested a review from thearifismail December 8, 2023 16:08
thearifismail
thearifismail previously approved these changes Dec 8, 2023
Copy link
Contributor

@thearifismail thearifismail left a comment

Choose a reason for hiding this comment

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

LGTM

@kruai kruai merged commit 34f1efa into master Dec 11, 2023
@kruai kruai deleted the readme-rh-pre-commit branch December 11, 2023 15:11
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