Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Issues #4151

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Improve Issues #4151

wants to merge 6 commits into from

Conversation

ffreyer
Copy link
Collaborator

@ffreyer ffreyer commented Aug 20, 2024

Description

Similar to #4108, this pr aims to make some improvements to our Issues (and Discussions) infrastructure. Feel free to give your opinions and suggestions.

Some general thoughts:

  • Issues should be actionable, i.e.
    • not be question, loose feature requests, planning or other open ended posts. Those should be Discussions
    • they should deal with one (preferably small) problem. So no roadmaps or other kinds of issue collections (Again, Discussions)
    • not be so old that their validity is unclear (but this is for issue cleanup)
  • duplicates should be closed in favor of the first such issue
  • We should take labels more seriously to make it easier to find specific issues. E.g.
    • tag what is affected, i.e. Makie/GLMakie/WGLMakie/CairoMakie/RPRMakie (maybe github docs, CI?)
    • tag the type of issue, i.e. bug/regression/documentation/enhancement
    • categorize issues by problem groups, e.g. plot attributes, rendering, DataInspector, transformations, 2D/3D
    • remove labels that are not applicable or have few related issues, e.g. dependencies, naming, planning, question, vizcon, GeometryBasics

@ffreyer ffreyer added the skip-changelog Skips changelog enforcer label Aug 20, 2024
@ffreyer
Copy link
Collaborator Author

ffreyer commented Aug 20, 2024

I'm planning to go through all the open issues at some point and close the ones that are too old to act on and add tags as I go. I think after that it'll be clearer what's actually useful to have there.

@MakieBot
Copy link
Collaborator

MakieBot commented Aug 20, 2024

Compile Times benchmark

Note, that these numbers may fluctuate on the CI servers, so take them with a grain of salt. All benchmark results are based on the mean time and negative percent mean faster than the base branch. Note, that GLMakie + WGLMakie run on an emulated GPU, so the runtime benchmark is much slower. Results are from running:

using_time = @ctime using Backend
# Compile time
create_time = @ctime fig = scatter(1:4; color=1:4, colormap=:turbo, markersize=20, visible=true)
display_time = @ctime Makie.colorbuffer(display(fig))
# Runtime
create_time = @benchmark fig = scatter(1:4; color=1:4, colormap=:turbo, markersize=20, visible=true)
display_time = @benchmark Makie.colorbuffer(fig)
using create display create display
GLMakie 4.42s (4.37, 4.46) 0.03+- 104.98ms (103.09, 105.96) 0.92+- 550.53ms (546.98, 558.44) 4.66+- 9.35ms (8.87, 9.57) 0.30+- 26.21ms (26.12, 26.33) 0.08+-
master 4.43s (4.40, 4.48) 0.03+- 105.93ms (104.03, 109.28) 1.92+- 546.85ms (543.86, 551.94) 3.20+- 9.59ms (9.48, 9.68) 0.07+- 25.97ms (25.71, 26.48) 0.26+-
evaluation 1.00x invariant, -0.01s (-0.35d, 0.52p, 0.03std) 1.01x invariant, -0.94ms (-0.63d, 0.27p, 1.42std) 0.99x invariant, 3.67ms (0.92d, 0.11p, 3.93std) 1.03x invariant, -0.23ms (-1.08d, 0.09p, 0.19std) 0.99x invariant, 0.24ms (1.25d, 0.05p, 0.17std)
CairoMakie 3.71s (3.68, 3.76) 0.03+- 105.76ms (102.84, 108.05) 1.83+- 163.59ms (161.09, 166.95) 1.88+- 9.04ms (8.44, 9.21) 0.27+- 1.12ms (1.10, 1.13) 0.01+-
master 3.94s (3.89, 3.99) 0.04+- 105.35ms (103.15, 107.03) 1.25+- 164.26ms (162.97, 166.47) 1.21+- 8.53ms (8.46, 8.83) 0.13+- 1.13ms (1.11, 1.14) 0.01+-
evaluation 1.06x faster✅, -0.22s (-6.61d, 0.00p, 0.03std) 1.00x invariant, 0.41ms (0.26d, 0.63p, 1.54std) 1.00x invariant, -0.66ms (-0.42d, 0.45p, 1.54std) 0.94x slower❌, 0.5ms (2.37d, 0.00p, 0.20std) 1.01x invariant, -0.01ms (-1.15d, 0.05p, 0.01std)
WGLMakie 4.59s (4.55, 4.72) 0.06+- 107.08ms (104.78, 112.43) 3.05+- 9.08s (8.96, 9.18) 0.08+- 11.13ms (10.71, 12.34) 0.57+- 121.50ms (115.90, 144.18) 10.16+-
master 4.55s (4.47, 4.64) 0.06+- 105.04ms (103.57, 107.30) 1.31+- 9.01s (8.85, 9.29) 0.15+- 10.84ms (10.67, 11.05) 0.15+- 117.65ms (112.05, 123.61) 3.57+-
evaluation 0.99x invariant, 0.03s (0.59d, 0.30p, 0.06std) 0.98x invariant, 2.05ms (0.87d, 0.14p, 2.18std) 0.99x invariant, 0.08s (0.64d, 0.26p, 0.12std) 0.97x invariant, 0.29ms (0.71d, 0.23p, 0.36std) 0.97x invariant, 3.85ms (0.51d, 0.37p, 6.86std)

title: ''
labels: bug
assignees: ''

---

Copy link
Member

@asinghvi17 asinghvi17 Aug 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!--
If this is about something that worked in an older version of Makie,
please file a regression report by going back to the issue page
and selecting the "Regression" template.
-->

@ffreyer
Copy link
Collaborator Author

ffreyer commented Aug 26, 2024

Might also be a good idea to have
```julia
# Your code here
```
as part of the templates for people that are new to the syntax

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skips changelog enforcer
Projects
Status: Needs discussion/help
Development

Successfully merging this pull request may close these issues.

3 participants