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

development.md: add coding guidelines #242

Merged
merged 1 commit into from
Oct 24, 2022

Conversation

aesteve-rh
Copy link
Member

First draft for including coding guidelines in the project.

Signed-off-by: Albert Esteve aesteve@redhat.com

@aesteve-rh aesteve-rh self-assigned this Jun 8, 2022
@aesteve-rh aesteve-rh requested review from rokkbert and bennyz June 8, 2022 15:24
@aesteve-rh aesteve-rh force-pushed the coding-guidelines branch from 2e1557a to 499206b Compare June 8, 2022 15:32
Copy link
Member

@mz-pdm mz-pdm left a comment

Choose a reason for hiding this comment

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

Thank you for putting it together. Some comments inside.

doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
Copy link
Member

@nirs nirs left a comment

Choose a reason for hiding this comment

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

Lets try to make the coding guidlines much shorter, and focus on the general rules instead of specific details.

doc/development.md Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
@aesteve-rh
Copy link
Member Author

I'll push an updated version after #255 gets integrated :)

@aesteve-rh aesteve-rh requested review from nirs and mz-pdm August 25, 2022 15:17
@aesteve-rh
Copy link
Member Author

Shortened the text and relaxed some statements + removed bad examples. Let's give it another iteration :)

Copy link
Member

@mz-pdm mz-pdm left a comment

Choose a reason for hiding this comment

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

Thanks for the changes, looks mostly good, just some typos and a couple of minor comments.

doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
doc/development.md Outdated Show resolved Hide resolved
mz-pdm
mz-pdm previously approved these changes Sep 2, 2022
@aesteve-rh
Copy link
Member Author

@nirs @tinez @mz-pdm Can you ack? If we still want to include this, anyway.

Copy link
Member

@mz-pdm mz-pdm left a comment

Choose a reason for hiding this comment

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

Looks good, just two cosmetic issues.

doc/development.md Outdated Show resolved Hide resolved
doc/development.md Show resolved Hide resolved
@aesteve-rh aesteve-rh requested a review from mz-pdm October 7, 2022 07:18
First draft for including coding guidelines in the project.

Signed-off-by: Albert Esteve <aesteve@redhat.com>
@mz-pdm mz-pdm force-pushed the coding-guidelines branch from 1a977eb to bace055 Compare October 24, 2022 11:13
@mz-pdm mz-pdm merged commit 6d37826 into oVirt:master Oct 24, 2022
@aesteve-rh aesteve-rh deleted the coding-guidelines branch October 24, 2022 11:41
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