11# How to contribute to JuMP
22
3- Welcome, this document explains some ways you can contribute to JuMP.
3+ The JuMP developers welcome and encourage new contributors. This document
4+ explains some ways you can contribute to JuMP.
45
56## Code of Conduct
67
@@ -22,10 +23,40 @@ help answer questions on the forum.
2223## Join the developer chatroom
2324
2425If you're interested in contributing code to JuMP, the next place to join is the
25- [ developer chatroom] ( https://jump.dev/chatroom ) . Let us know what you
26- have in mind, and we can point you in the right direction.
26+ [ developer chatroom] ( https://jump.dev/chatroom ) . Let us know what you have in
27+ mind, and we can point you in the right direction.
2728
28- ## Improve the documentation
29+ ## The best ways to contribute
30+
31+ The best ways you can get involved are:
32+
33+ 1 . ** Find and report bugs** : we can't fix things that we don't know about. There
34+ are always new bugs (or inconsistencies that we should better document) to
35+ find. Report a bug by [ opening a GitHub issue] ( https://github.com/jump-dev/JuMP.jl/issues ) .
36+
37+ Using AI tools to find bugs is acceptable, but you are responsible for
38+ understanding and explaining _ why_ the issue is a bug in your own words.
39+ Rather than copy-pasting only the content of the AI analysis into the issue,
40+ first explain what you did to find and verify the bug, and then copy-paste
41+ the AI tool's output.
42+
43+ Also note that there are many repositories in the JuMP ecosystem. Don't worry
44+ if you open an issue in the "wrong" one; we can easily transfer it to the
45+ correct repository.
46+
47+ 2 . ** Tell us about confusing parts of the documentation** : if you get stuck
48+ trying to do something in JuMP, it means we didn't document things well
49+ enough. If you have suggestions for new tutorials we could add or how we
50+ could improve the documentation please leave a comment at
51+ [ "Suggestions for documentation improvements"] ( https://github.com/jump-dev/JuMP.jl/issues/2348 ) .
52+
53+ 3 . ** Make your own packages** : write your own solver or JuMP extension under
54+ your personal account. There are no rules here. Vibe code as much as you
55+ like. Tell us about the things you have created by posting on the
56+ [ community forum] ( https://jump.dev/forum ) , or give a talk at a
57+ [ JuMP-dev workshop] ( https://jump.dev/categories/#jump-dev ) .
58+
59+ ## How to improve the documentation
2960
3061Chances are, if you asked (or answered) a question on the community forum, then
3162it is a sign that the [ documentation] ( https://jump.dev/JuMP.jl/dev/ ) could be
@@ -44,14 +75,13 @@ on how to do this.)
4475
4576If your change is larger, or touches multiple files, you will need to make the
4677change locally and then use Git to submit a pull request. (See
47- [ Contribute code to JuMP] ( @ref ) below for more on this.)
78+ [ How to contribute code to JuMP] ( @ref ) below for more on this.)
4879
4980!!! tip
50- If you need any help, come join the
51- [ developer chatroom] ( https://jump.dev/chatroom ) and we will walk
52- you through the process.
81+ If you need any help, come join the [ developer chatroom] ( https://jump.dev/chatroom )
82+ and we will walk you through the process.
5383
54- ## File a bug report
84+ ## How to file a bug report
5585
5686Another way to contribute to JuMP is to file
5787[ bug reports] ( https://github.com/jump-dev/JuMP.jl/issues/new?template=bug_report.md ) .
@@ -61,12 +91,11 @@ before posting. You can also find a copy of that info
6191[ here] ( https://github.com/jump-dev/JuMP.jl/blob/master/.github/ISSUE_TEMPLATE/bug_report.md ) .
6292
6393!!! tip
64- If you're unsure whether you have a real bug, post on the
65- [ community forum] ( https://jump.dev/forum )
94+ If you're unsure whether you have a real bug, post on the [ community forum] ( https://jump.dev/forum )
6695 first. Someone will either help you fix the problem, or let you know the
6796 most appropriate place to open a bug report.
6897
69- ## Contribute code to JuMP
98+ ## How to contribute code to JuMP
7099
71100Finally, you can also contribute code to JuMP.
72101
@@ -89,14 +118,14 @@ JuMP is similar to the following:
89118The first step is to find an [ open issue] ( https://github.com/jump-dev/JuMP.jl/issues )
90119(or open a new one) for the problem you want to solve. Then, _ before_ spending
91120too much time on it, discuss what you are planning to do in the issue to see if
92- other contributors are fine with your proposed changes. Getting feedback early can
93- improve code quality, and avoid time spent writing code that does not get merged into
94- JuMP.
121+ other contributors are fine with your proposed changes. Getting feedback early
122+ can improve code quality and avoid time spent writing code that does not get
123+ merged into JuMP.
95124
96125!!! tip
97126 At this point, remember to be patient and polite; you may get a _ lot_ of
98- comments on your issue. However, do not be afraid. Comments mean that people are
99- willing to help you improve the code that you are contributing to JuMP.
127+ comments on your issue. However, do not be afraid. Comments mean that people
128+ are willing to help you improve the code that you are contributing to JuMP.
100129
101130** Step 2: fork JuMP**
102131
0 commit comments