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
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ We gratefully acknowledge the general [Julia CONTRIBUTING.md document](https://g
6
6
7
7
## Learning Julia
8
8
9
-
A pre-requisite for using JuliaImages is to know at least a little about Julia itself. [The learning page](https://julialang.org/learning) has a great list of resources for new and experienced users alike. [This tutorial video](https://www.youtube.com/watch?v=vWkgEddb4-A) is one recommended starting point, as is the "[Invitation to Julia](https://www.youtube.com/watch?v=gQ1y5NUD_RI)" workshop video from JuliaCon 2015 ([slide materials here](https://github.com/dpsanders/invitation_to_julia)). The [Julia documentation](https://docs.julialang.org) covers the language and core library features, and is searchable.
9
+
A pre-requisite for using JuliaImages is to know at least a little about Julia itself. [The learning page](https://julialang.org/learning) has a great list of resources for new and experienced users alike. The [Julia documentation](https://docs.julialang.org) covers the language and core library features, and is searchable.
10
10
11
11
## Learning JuliaImages
12
12
@@ -34,6 +34,12 @@ Changes to the "docstrings" (the string preceding a method in source code) shoul
34
34
35
35
For bigger documentation changes, it is probably best to clone the package and submit the changes as an ordinary pull request, as described below under "Contributing code." You can build the package locally if you install [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl), and run `include("make.jl")` in the `docs/` folder. To see the completed documentation, open the `build/index.md` file in your browser.
36
36
37
+
Possible documentation contributions could be:
38
+
- Typo fixes
39
+
- Wording fixes to make something more clear
40
+
- Additional examples that highlight some functionality
41
+
- Find more [documentation issues](https://github.com/JuliaImages/Images.jl/labels/documentation)
42
+
37
43
## Contributing code
38
44
39
45
*By contributing you agree to be bound by JuliaImages' MIT license*
@@ -80,7 +86,7 @@ extensive changes without needing to rebuild the package in order to test
80
86
your changes.
81
87
82
88
* Debuggers can help you get to the root of a problem. There are many choices and interfaces:
83
-
+[Juno](https://github.com/JunoLab/Juno.jl) has a polished GUI for debugging
89
+
+[VSCode](https://code.visualstudio.com/docs/languages/julia#_debugging) has a polished GUI for debugging
84
90
+[Debugger](https://github.com/JuliaDebug/Debugger.jl) has a polished command-line interface
85
91
+[Rebugger](https://github.com/timholy/Rebugger.jl) has an innovative but somewhat less-polished command-line interface
86
92
+[Infiltrator](https://github.com/JuliaDebug/Infiltrator.jl) offers more limited debugging, but often it's precisely what you need while avoiding the performance penalties that some of the other options suffer from.
0 commit comments