# Guidelines for writing an issue?

**URL:** <https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204>\
**Category:** Meta Discussion\
**Tags:** github, github-actions\
**Created:** [July 23, 2021, 7:18pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204 "2021-07-23T19:18:07Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![Michael\_Barmann](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/michael_barmann/32/20389_2.png) [@Michael\_Barmann](https://discourse.julialang.org/u/Michael_Barmann)\
**Post date:** [July 23, 2021, 7:18pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/1 "2021-07-23T19:18:07Z")

</div>

I would like to open an issue on Github about a minor [problem](https://discourse.julialang.org/t/convergence-in-optim-questions/65139) I have encountered in Optim.jl. I have never opened an issue before–are there any general guidelines for what to include in an issue/how to write an issue? Are there any differences in what I should inclue in an issue versus a Discord post? I think it would be helpful (for new users especially) to have some sort of guidelines on this site about how to write an issue.

---

<div class="post-metadata">

**Author:** ![Oscar\_Smith](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/oscar_smith/32/25343_2.png) [@Oscar\_Smith](https://discourse.julialang.org/u/Oscar_Smith)\
**Post date:** [July 23, 2021, 7:47pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/2 "2021-07-23T19:47:48Z")

</div>

It depends a bit on what the problem is, but for the most part, it’s just clear title, mwe, expected result, actual result. If you have a suggested fix, that can go in too.

---

<div class="post-metadata">

**Author:** ![aramirezreyes](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/aramirezreyes/32/42573_2.png) [@aramirezreyes](https://discourse.julialang.org/u/aramirezreyes)\
**Post date:** [July 23, 2021, 8:07pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/3 "2021-07-23T20:07:15Z")

</div>

And versions! At least the version of the package that you are using, and the version of julia (output of versioninfo() ).

---

<div class="post-metadata">

**Author:** ![Michael\_Barmann](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/michael_barmann/32/20389_2.png) [@Michael\_Barmann](https://discourse.julialang.org/u/Michael_Barmann)\
**Post date:** [July 23, 2021, 8:13pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/4 "2021-07-23T20:13:55Z")

</div>

Thanks!

---

<div class="post-metadata">

**Author:** ![Michael\_Barmann](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/michael_barmann/32/20389_2.png) [@Michael\_Barmann](https://discourse.julialang.org/u/Michael_Barmann)\
**Post date:** [July 23, 2021, 8:14pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/5 "2021-07-23T20:14:17Z")

</div>

Thank you! Just added the package version and my versioninfo()!

---

<div class="post-metadata">

**Author:** ![mkitti](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mkitti/32/12459_2.png) [@mkitti](https://discourse.julialang.org/u/mkitti)\
**Post date:** [July 23, 2021, 9:33pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/6 "2021-07-23T21:33:31Z")

</div>

The [issue](https://github.com/JuliaNLSolvers/Optim.jl/issues/934) looks pretty good to me.

If you wanted to take it one further step, you could see if the issue still applies to the the master branch or whatever the development branch may be:

```julia
(@v1.6) pkg> activate --temp # Create a temporary environment

(jl_OP78Sk) pkg> add https://github.com/JuliaNLSolvers/Optim.jl.git#master

```

This is optional but often appreciated if the development branch has a few commits that have not been released.

---

<div class="post-metadata">

**Author:** ![Michael\_Barmann](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/michael_barmann/32/20389_2.png) [@Michael\_Barmann](https://discourse.julialang.org/u/Michael_Barmann)\
**Post date:** [July 23, 2021, 9:36pm UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/7 "2021-07-23T21:36:21Z")

</div>

Thanks, that’s a good tip!

---

<div class="post-metadata">

**Author:** ![giordano](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/giordano/32/2166_2.png) [@giordano](https://discourse.julialang.org/u/giordano)\
**Post date:** [July 24, 2021, 12:19am UTC](https://discourse.julialang.org/t/guidelines-for-writing-an-issue/65204/8 "2021-07-24T00:19:03Z")

</div>

> [@mkitti](#):
>
> `(jl_OP78Sk) pkg> add https://github.com/JuliaNLSolvers/Optim.jl.git#master`

Or more simply

```julia
]add Optim#master

```