adding readme section about style guides #1391
Merged
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #1391 +/- ##
===============================================
+ Coverage 68.017% 68.229% +0.212%
- Complexity 8361 8654 +293
===============================================
Files 571 571
Lines 33877 34424 +547
Branches 5662 5872 +210
===============================================
+ Hits 23042 23487 +445
- Misses 8645 8714 +69
- Partials 2190 2223 +33
|
pshapiro4broad
approved these changes
Jun 24, 2019
README.md
Outdated
| @@ -88,6 +88,10 @@ To create a project in IntelliJ IDE for htsjdk do the following: | |||
|
|
|||
| From time to time if dependencies change in htsjdk you may need to refresh the project from the `View -> Gradle` menu. | |||
|
|
|||
| ### Code style | |||
| Style guides files are included for Intellij and Eclipse. These are a variation of the [Google Java Style](https://google.github.io/styleguide/javaguide.html) with 4 space indentation. | |||
| This style is suggested for new code but not rigidly checked. We allow for contributors to deviate from the style when it improves clarity or to match surrounding code. Existing code does not necessarily conform to this and does not need to be modified to do so. | |||
There was a problem hiding this comment.
Existing code does not necessarily conform to this and does not need to be modified to do so.
How about
Existing code does not necessarily conform to this and does not need to be modified to do so, but users are encouraged to correct the formatting of code that they modify.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a statement about code style to the readme.