Skip to content
Snippets Groups Projects
Commit 8d31881e authored by Thibault Lestang's avatar Thibault Lestang
Browse files

Merge branch 'update_contributing' into 'master'

Update contributing guidelines following reformatting

See merge request nektar/nektar!1363
parents ebad393a 7cc4b17c
No related branches found
No related tags found
No related merge requests found
......@@ -131,11 +131,6 @@ remains unmerged for more than a couple of days.
to keep test files as small as possible. If so you'll need to rebase or
filter-branch to remove those from the commit history.
- Is the code formatted correctly?
- **Note:** unfortunately, Nektar++ has pretty inconsistent code formatting at
the moment. To help in reviewing your submission, new files should be
formatted according to the guidelines (or use `clang-format` as described
below) -- otherwise, try to keep formatting consistent with the file you're
working on.
## Git cheatsheet
Although Gitlab gives a nice interface to view the diff between a branch and
......@@ -352,8 +347,8 @@ changes are required before merging.
Code formatting is reasonably boring, so Nektar++ comes with a `.clang-format`
file to allow for automatic code formatting.
Installing it is straightforward on most package managers. Nektar++ relies on
options that are used in version 11 or later.
Installing it is straightforward on most package managers. Nektar++'s
source code is formatted using **clang-format 11**.
There are a number of instructions on how to use `clang-format` inside a number
of text editors on the
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment