Skip to content

Commit 24051e9

Browse files
contributing.md
1 parent d483c9e commit 24051e9

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## How to contribute to ClustForOpt.jl
2+
Welcome! Thank you for considering to contribute to `ClustForOpt.jl`. If you have a comment, question, feature request, or bug report, please open a new [issue](https://github.com/holgerteichgraeber/ClustForOpt.jl/issues).
3+
4+
If you like to file a bug report, or like to contribute to the documentation or the code (always welcome!), the [JuMP.jl Contributing.md](https://github.com/JuliaOpt/JuMP.jl/blob/master/CONTRIBUTING.md) has some great tips on how to get started.

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,9 @@ Pkg.add("ClustForOpt")
3131
```
3232

3333
## Documentation
34-
Please refer to the documentation for details on how to use ClustForOpt:
35-
[Documentation (Stable)](https://holgerteichgraeber.github.io/ClustForOpt.jl/stable)
34+
[Documentation (Stable)](https://holgerteichgraeber.github.io/ClustForOpt.jl/stable): Please refer to this documentation for details on how to use ClustForOpt the current version of ClustForOpt. This is the documentation of the default version of the package.
3635

37-
The documentation for the development version of ClustForOpt can be found here:
38-
[Documentation (Development)](https://holgerteichgraeber.github.io/ClustForOpt.jl/dev)
36+
[Documentation (Development)](https://holgerteichgraeber.github.io/ClustForOpt.jl/dev): If you like to try the development version of ClustForOpt, please refer to this documentation.
3937

4038
**See [NEWS](NEWS.md) for significant breaking changes when updating from one version of ClustForOpt to another.**
4139

0 commit comments

Comments
 (0)