You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+19-5
Original file line number
Diff line number
Diff line change
@@ -44,6 +44,18 @@ Julia has a built-in [package manager](https://github.com/JuliaLang/METADATA.jl)
44
44
45
45
For developers who need to wrap C libraries so that they can be called from Julia, the [Clang.jl](https://github.com/ihnorton/Clang.jl) package can help generate the wrappers automatically from the C header files.
46
46
47
+
### Writing tests
48
+
49
+
There are never enough tests. Track [code coverage at Coveralls](https://coveralls.io/r/JuliaLang/julia), and help improve it.
50
+
51
+
1. Go visit https://coveralls.io/r/JuliaLang/julia.
52
+
53
+
2. Browse through the source files and find some untested functionality (highlighted in red) that you think you might be able to write a test for.
54
+
55
+
3. Write a test that exercises this functionality---you can add your test to one of the existing files, or start a new one, whichever seems most appropriate to you. If you're adding a new test file, make sure you include it in the list of tests in `test/runtests.jl`. http://julia.readthedocs.org/en/latest/stdlib/test/ may be helpful in explaining how the testing infrastructure works. Submit the test as a pull request (see [CONTRIBUTING.md](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md)).
56
+
57
+
[Issue 9493](https://github.com/JuliaLang/julia/issues/9493) has a more detailed discussion on code coverage.
58
+
47
59
### Improving documentation
48
60
49
61
*By contributing documentation to Julia, you are agreeing to release it under the [MIT License](https://github.com/JuliaLang/julia/tree/master/LICENSE.md).*
@@ -103,7 +115,9 @@ or with the `runtests.jl` script, e.g. to run `test/bitarray.jl` and `test/math.
103
115
104
116
Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request with a [`Good to merge` message](http://blog.travis-ci.com/2012-09-04-pull-requests-just-got-even-more-awesome/).
105
117
106
-
##### General Formatting Guidelines For Julia code contributions
118
+
### Code Formatting Guidelines
119
+
120
+
#### General Formatting Guidelines for Julia code contributions
107
121
108
122
- 4 spaces per indentation level, no tabs
109
123
- use whitespace to make the code more readable
@@ -113,7 +127,7 @@ Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request w
113
127
- use upper camel case convention for modules, type names
114
128
- use lower case with underscores for method names
115
129
116
-
#####General Formatting Guidelines For C code contributions
130
+
#### General Formatting Guidelines For C code contributions
117
131
118
132
- 4 spaces per indentation level, no tabs
119
133
- space between if and ( (if (x) ...)
@@ -123,7 +137,7 @@ Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request w
123
137
- if one part of an if..else chain uses { } then all should
124
138
- no whitespace at the end of a line
125
139
126
-
#####Git Recommendations For Pull Requests
140
+
### Git Recommendations For Pull Requests
127
141
128
142
- Avoid working from the `master` branch of your fork, creating a new branch will make it easier if Julia's `master` changes and you need to update your pull request.
129
143
- Try to [squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code so your pull request is easier to review, and Julia's history won't have any broken intermediate commits. A reasonable number of separate well-factored commits is fine, especially for larger changes.
@@ -153,8 +167,8 @@ While getting familiar with Julia, remember to check out [the docs](http://docs.
0 commit comments