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 recommendations for coding styles #64

Merged
merged 6 commits into from
Jun 29, 2022

Conversation

jillr
Copy link
Contributor

@jillr jillr commented May 18, 2022

Draft of coding styles recommendations from ansible eng

@jillr jillr marked this pull request as draft May 18, 2022 22:41
@jillr
Copy link
Contributor Author

jillr commented May 18, 2022

cc @cidrblock

@jillr jillr changed the title [WIP] Add recommendations for coding styles Add recommendations for coding styles May 24, 2022
@jillr jillr marked this pull request as ready for review May 24, 2022 16:19
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@sean-m-sullivan sean-m-sullivan left a comment

Choose a reason for hiding this comment

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

LGTM, its going to evolve over time, but this is a good start.

Copy link
Contributor

@ericzolf ericzolf left a comment

Choose a reason for hiding this comment

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

Again good inputs, more formal comments than regarding the content.

Overall we're trying to align this section (and the roles one) to the overall pattern explanation/rationale/example, so if you could start to stick to it, that would be helpful, but on the other hand, the coding recommendations are generally very short so it's a lot of boilerplate...

Regarding the task names, I really hate having them start with a capital letter (only my play names start with a capital letter), but we can discuss this in the group.

coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@mophahr mophahr left a comment

Choose a reason for hiding this comment

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

I have a few small suggestions but otherwise this looks good to me.

coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Outdated Show resolved Hide resolved
coding_style/README.adoc Show resolved Hide resolved
@mophahr
Copy link
Contributor

mophahr commented Jun 22, 2022

This looks good now. Thanks @jillr

@ericzolf please have another look to se if you're happy now, too. If you feel strongly about the lowercase task names, you could open a PR for it and we discuss it separately from this PR here in the CoP meeting.

@ericzolf
Copy link
Contributor

Approved in CoP meeting 2022-06-29

@ericzolf ericzolf merged commit 284d18d into redhat-cop:main Jun 29, 2022
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.

None yet