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

Document and test clang format options; append style.md details #9

Merged
merged 8 commits into from
Oct 23, 2023

Conversation

tanaya-mankad
Copy link
Contributor

@tanaya-mankad tanaya-mankad commented Oct 11, 2023

Description

Replace the content in this section with:

  • The motivation and context for this change (if it is not immediately clear from the title)
  • If it fixes an open issue, specify the issue number (e.g., "fixes #XXXX")
  • A summary of the behavior expected from this change
  • A description of tests performed

Author Progress Checklist:

  • Open draft pull request
    • Make title clearly understandable in a standalone change log context
    • Assign yourself the issue
    • Add at least one label
  • Make code changes (if you haven't already)
  • Self-review of code
    • My code follows the style guidelines of this project
    • I have performed a self-review of my code
    • I have added comments to my code, particularly in hard-to-understand areas
    • I have only committed the necessary changes for this fix or feature
    • I have made corresponding changes to the documentation
    • My changes generate no new warnings
    • I have ensured that my fix is effective or that my feature works as intended by:
      • exercising the code changes in the test framework, and/or
      • manually verifying the changes (as explained in the the pull request description above)
    • My changes pass all local tests
    • My changes successfully passes CI checks
  • Move pull request out of draft mode and assign reviewers
  • Iterate with reviewers until all changes are approved
    • Make changes in response to reviewer comments
    • Re-request review in GitHub

Reviewer Checklist:

  • Read the pull request description
  • Perform a code review on GitHub
  • Confirm all CI checks pass and there are no build warnings
  • Pull, build, and run automated tests locally
  • Perform manual tests of the fix or feature locally
  • Add any review comments, if applicable
  • Submit review in GitHub as either
    • Request changes, or
    • Approve
  • Iterate with author until all changes are approved
  • If you are the last reviewer to approve, merge the pull request and delete the branch

@tanaya-mankad tanaya-mankad added the documentation Improvements or additions to documentation label Oct 11, 2023
@tanaya-mankad tanaya-mankad self-assigned this Oct 11, 2023
Copy link
Member

@nealkruis nealkruis left a comment

Choose a reason for hiding this comment

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

Minor questions, but this is probably good enough to have a discussion.

doc/style.md Outdated

#include <fmt.h>
#include "my_class_impl.h"
Copy link
Member

Choose a reason for hiding this comment

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

This violates the file naming rule above.

doc/style.md Outdated
Comment on lines 62 to 66
* Do use names that are
* descriptive
* intention-revealing
* self-documenting
* pronounceable
Copy link
Member

Choose a reason for hiding this comment

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

This should maybe be across all names (not just variable names?)

@michael-okeefe
Copy link
Member

Looks good to me. Thank you.

@nealkruis nealkruis merged commit 5e3d3b8 into main Oct 23, 2023
10 checks passed
@nealkruis nealkruis deleted the document-clang-format-options branch October 23, 2023 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants