-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,6 +32,23 @@ 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 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 | ||
------------- | ||
|
||
|