Flux.jl icon indicating copy to clipboard operation
Flux.jl copied to clipboard

RFC: add issue forms

Open ToucheSir opened this issue 2 years ago • 4 comments

Reference on GH docs: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

ToucheSir avatar Jun 27 '22 01:06 ToucheSir

Linked to rendered template: https://github.com/FluxML/Flux.jl/blob/bde0d43c3d1cdb3f430f3e5ad9303a28acefcf65/.github/ISSUE_TEMPLATE/bug-report.yml

Live version to play with: https://github.com/ToucheSir/issue-form-example/issues/new/choose

If this format makes sense, we can add similar a similar template for feature requests.

ToucheSir avatar Jun 27 '22 01:06 ToucheSir

Codecov Report

Merging #2011 (bde0d43) into master (97f981b) will increase coverage by 5.25%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2011      +/-   ##
==========================================
+ Coverage   81.85%   87.10%   +5.25%     
==========================================
  Files          20       20              
  Lines        1626     1528      -98     
==========================================
  Hits         1331     1331              
+ Misses        295      197      -98     
Impacted Files Coverage Δ
src/optimise/train.jl 93.93% <0.00%> (+2.76%) :arrow_up:
src/cuda/cudnn.jl 100.00% <0.00%> (+9.09%) :arrow_up:
src/losses/ctc.jl 93.81% <0.00%> (+46.66%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 97f981b...bde0d43. Read the comment docs.

codecov-commenter avatar Jun 27 '22 01:06 codecov-commenter

Asking about the OS and the Julia version would be nice too!

Saransh-cpp avatar Aug 27 '22 18:08 Saransh-cpp

The template looks a lot less intimidating once rendered. However, I stopped iterating on it because the editing experience is rather clunky (no live preview, among other things).

One simpler alternative is to clone the CUDA.jl issue templates, which are much shorter. This issue form was actually inspired by those.

ToucheSir avatar Aug 27 '22 20:08 ToucheSir

Since this was last posted, we added org-wide templates which are both less onerous to develop and to fill out.

ToucheSir avatar Dec 11 '22 00:12 ToucheSir