Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Open sidebar
Nektar
Nektar
Commits
fc436cad
Commit
fc436cad
authored
Mar 01, 2016
by
Dave Moxey
Committed by
Spencer Sherwin
Mar 04, 2016
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update formatting, add contents, fix a couple of typos
parent
e99e3b6c
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
1 deletion
+16
-1
CONTRIBUTING.md
CONTRIBUTING.md
+16
-1
No files found.
CONTRIBUTING.md
View file @
fc436cad
Contributing to Nektar++
========================
## Contents
This is a reasonably complete guide to help if you're interested in contributing
to Nektar++, either in reporting bugs or, hopefully, trying to fix them! It's
split up into a number of sections:
-
[
Issues and bug reports
](
#issues-and-bug-reports
)
-
[
How to contribute
](
#how-to-contribute
)
-
[
Submission checklist
](
#submission-checklist
)
-
[
Git cheatsheet
](
#git-cheatsheet
)
-
[
Testing and Buildbot
](
#testing-and-buildbot
)
-
[
Documentation
](
#documentation
)
-
[
Formatting guidelines
](
#formatting-guidelines
)
## Issues and bug reports
Think you've found a bug or issue with Nektar++? We're very keen to hear about
it!
...
...
@@ -78,7 +91,7 @@ This gives you four commands:
If you prefer a graphical interface to see the files that have changed in your
commit, you can additionally use the
`git gui`
command to bring up a simple
interface.
`git difftool`
can also be used in combination with a GUI diff
viewer, to graphically view the output
`git diff`
.
viewer, to graphically view the output
of
`git diff`
.
## Testing and Buildbot
Your new features or fixes should include tests that cover the code you've
...
...
@@ -148,12 +161,14 @@ below this would be fantastic.
but don't use trailing inline comments to save the 80 character limit!
-
All code blocks (even one-line blocks) should use braces, and braces should be
on new lines; for instance
```
c++
if
(
someCondition
)
{
myAwesomeFunction
();
}
```
-
**
Don't use preprocessor directives and macros unless there is no viable
alternative.
**
-
However, please make sure you do have a header guard inside your
`.h`
files,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment