-
Notifications
You must be signed in to change notification settings - Fork 34
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
Guard missed test and document how to style #1210
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,6 +32,24 @@ to one of ``A``'s instance variables ``Foo f``, ``B`` should store a non-owning | |
either ``Foo&`` or ``Foo*``. This should be ``const`` if at all possible. In this case, shared ownership | ||
is not required because the lifetime of ``B`` is entirely dependent on the lifetime of ``A``. | ||
|
||
How to style your code | ||
---------------------- | ||
|
||
We have two methods of enabling styling your code via ClangFormat. | ||
|
||
The first method is to use the `style` build target on a configuration with the correct version of | ||
ClangFormat enabled. Here is an example on how to do it on LC's Ruby machine: | ||
|
||
.. code-block:: bash | ||
|
||
$ ./config-build.py host-configs/[email protected] | ||
$ cd [email protected] | ||
$ make style | ||
|
||
The second method is to make a comment of ``/style`` on your open GitHub pull request. This will trigger | ||
a GitHub Action that will automatically style your code and commit it to your branch. You will need to | ||
`git pull` after it is finished to continue to work on that branch. | ||
|
||
Documentation | ||
------------- | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Who is allowed to make use of this
/style
command?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitely anyone who has write access to our repo can trigger it. I would need to try what happens if someone outside our organization does it. They certainly cannot change the behavior or the GitHub Action.