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.

Sign up for GitHub

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

Jump to bottom

Update coding guidelines #1015

Merged
merged 5 commits into from
Mar 10, 2023
Merged

Update coding guidelines #1015

merged 5 commits into from
Mar 10, 2023

Conversation

dataclouder
Copy link
Contributor

@dataclouder dataclouder commented Mar 8, 2023 •
edited
Loading

Adding a section about documentation and changelog entries, explaining the following:

  • What documentation we write
  • The components of each docs page
  • The types of CHANGELOG entries that each PR should provide

NOTE to reviewers: For better readability, please read the coding guidelines page online before commenting

Giuseppe Maxia added 2 commits March 8, 2023 21:13
Update CODING_GUIDELINES.md
886e063 
Adding a section about documentation and changelog entries

Signed-off-by: Giuseppe Maxia <[email protected]>
Add changelog entry
fe67c7f 
Signed-off-by: Giuseppe Maxia <[email protected]>
@dataclouder dataclouder marked this pull request as ready for review March 8, 2023 20:21
lvirbalas
lvirbalas requested changes Mar 9, 2023
View reviewed changes
Copy link
Collaborator

@lvirbalas lvirbalas left a comment

Choose a reason for hiding this comment

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

This is great! Few suggestions inline.

CODING_GUIDELINES.md Outdated Show resolved Hide resolved
CODING_GUIDELINES.md Outdated Show resolved Hide resolved
CODING_GUIDELINES.md Show resolved Hide resolved
Update CODING_GUIDELINES.md
c4a150c 
Signed-off-by: Giuseppe Maxia <[email protected]>
Fix paragraph link
4e71b9d 
Signed-off-by: Giuseppe Maxia <[email protected]>
adambarreiro
adambarreiro approved these changes Mar 9, 2023
View reviewed changes
Copy link
Collaborator

@adambarreiro adambarreiro left a comment

Choose a reason for hiding this comment

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

Perfectly explained

.changes/v3.9.0/1015-notes.md Outdated Show resolved Hide resolved
Fix PR number in changelog entry
32a8faa 
Signed-off-by: Giuseppe Maxia <[email protected]>
lvirbalas
lvirbalas approved these changes Mar 9, 2023
View reviewed changes
Copy link
Collaborator

@lvirbalas lvirbalas 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 additions!

@dataclouder dataclouder merged commit 3ff23be into vmware:main Mar 10, 2023
@dataclouder dataclouder deleted the update-conding-guidelines branch November 20, 2023 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adezxc adezxc adezxc approved these changes

@Didainius Didainius Didainius approved these changes

@lvirbalas lvirbalas lvirbalas approved these changes

@adambarreiro adambarreiro adambarreiro approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dataclouder @adambarreiro @lvirbalas @Didainius @adezxc