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

Add additional documentation for Python, Rego, and YAML contribs #80

Merged
merged 3 commits into from
Jan 23, 2021

Conversation

phenixblue
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind bug
/kind cleanup
/kind deprecation
/kind design

/kind documentation

/kind feature

What this PR does / why we need it:

Since we've matured several different processes related to CI and built out associated Make targets to provide macros for common contributor tasks, we needed to update our Contributor docs.

These updates include specific tasks such as code formatting, linting, and unit tests for Python, Rego, and BASH.

Which issue(s) this PR fixes:

Fixes #54

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

Additional documentation e.g., usage docs, etc.:


@phenixblue phenixblue added documentation Improvements or additions to documentation contrib Related to Contributors or the Contribution process labels Jan 20, 2021
@phenixblue phenixblue added this to To Do in v2.3.0 via automation Jan 20, 2021
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ilrudie ilrudie left a comment

Choose a reason for hiding this comment

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

lgtm

@phenixblue phenixblue merged commit 66298ef into tmobile:master Jan 23, 2021
@phenixblue phenixblue deleted the contrib-docs branch January 23, 2021 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contrib Related to Contributors or the Contribution process documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add more detail around contrib scenarios
2 participants