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

Update Contrib doc #4068

Merged
merged 6 commits into from
Oct 7, 2018
Merged

Update Contrib doc #4068

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
56e3c19
Add link for style
drashna Oct 4, 2018
1f588fe
ignore java
drashna Oct 4, 2018
3cd6bdd
Add example and update link?
drashna Oct 4, 2018
744067d
Minor fixes
drashna Oct 4, 2018
8fc4a6f
Change 1TBS text
drashna Oct 4, 2018
f13eb3f
comments
drashna Oct 4, 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
19 changes: 18 additions & 1 deletion docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Never made an open source contribution before? Wondering how contributions work
Most of our style is pretty easy to pick up on, but right now it's not entirely consistent. You should match the style of the code surrounding your change, but if that code is inconsistent or unclear use the following guidelines:

* We indent using two spaces (soft tabs)
* We use One True Brace Style
* We use [One True Brace Style](http://google.github.io/styleguide/javaguide.html) (java specific things should be ignored)
Copy link
Contributor

Choose a reason for hiding this comment

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

With the example, I don't think this link is needed. Adding Java into the mix might just make things confusing.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we need the word modified here?

  • We use a modified One True Brace Style

* Opening Brace: At the end of the same line as the statement that opens the block
* Closing Brace: Lined up with the first character of the statement that opens the block
* Else If: Place the closing brace at the beginning of the line and the next opening brace at the end of the same line.
Expand All @@ -72,6 +72,23 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely
* In general we don't wrap lines, they can be as long as needed. If you do choose to wrap lines please do not wrap any wider than 76 columns.
* We use `#pragma once` at the start of header files rather than old-style include guards (`#ifndef THIS_FILE_H`, `#define THIS_FILE_H`, ..., `#endif`)

Here is an example for easy reference:

```c
enum foo_state {
FOO_BAR,
FOO_BAZ,
};

int foo(void) {
if (cond1) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe make this some_condition, cond1 seems oddly specific (I know I wrote this lol).

return FOO_BAR;
} else {
return -1;
}
}
```

drashna marked this conversation as resolved.
Show resolved Hide resolved
# General Guidelines

We have a few different types of changes in QMK, each requiring a different level of rigor. We'd like you to keep the following guidelines in mind no matter what type of change you're making.
Expand Down