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.

Sign up for GitHub

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

Jump to bottom

update to include documentation on running uncrustify #796

Merged
merged 4 commits into from
May 31, 2018
Merged

update to include documentation on running uncrustify #796

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
40471c9
update to include documentation on running uncrustify
dgergel May 22, 2018
4dc0a82
update with Joe's edits
dgergel May 22, 2018
53a99c0
Merge branch 'develop' into feature/add_uncrustify_developer_document…
May 23, 2018
1477501
Merge branch 'develop' into feature/add_uncrustify_developer_document…
bartnijssen May 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/Development/working-with-git.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,9 @@ To register the deletion of a file:

This will bring up a commit log in your default editor. The list of files whose changes will be committed (i.e. were registered via "git add" etc) is shown in the header at the top of the file. If you disagree with this list, exit the editor and do "git add" etc as necessary to correct the list, and then try "git commit" again. If satisfied with the list of changed files, add a description of the set of changes (including a brief description of the problem that motivated the changes). Save and exit.

### 3. Correcting code syntax issues prior to creating a PR
After completing your code commits, you also need to check that your code is compliant with C conventions for indentation and spacing. Please make sure you have `uncrustify` installed, and you will need either version `0.64` or later. Once you have installed `uncrustify`, you should navigate to the `~/tools/code_format` directory in the VIC repo and run `uncrustify`, which you can do by running the script in that directory, `./run_uncrustify.bash`. A simple `git diff --name-only` will list all files that `uncrustify` has updated the syntax for. If any files come up that you have edited, you should commit those syntax edits.

Copy link
Member

Choose a reason for hiding this comment

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

I've made a few changes to the paragraph...

After completing your code changes, you also need to check that your code is compliant with VIC's style conventions for indentation and spacing. Please make sure you have uncrustify installed (version 0.64 or later). Once you have installed uncrustify, you should navigate to the ...VIC/tools/code_format directory in the VIC repo and run uncrustify, which you can do by running the script in that directory, ./run_uncrustify.bash. A simple git diff --name-only will list all files that uncrustify has updated the syntax for. If any files come up that you have edited, you should commit those syntax edits.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @jhamman, just updated with your edits

### Pushing commits to your fork

After committing your changes, you should push them to your fork (which has the alias `origin`) stored on GitHub:
Expand Down