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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report-.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
name: 'Bug report '
about: Create a report to help us improve
name: Bug report
about: Report an error or incorrect behavior
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.
-->

- [ ] what version of Makie are you running? (`]st -m Makie`)
- [ ] can you reproduce the bug with a fresh environment ? (`]activate --temp; add Makie`)
- [ ] What platform + GPU are you on?
- [ ] Which backend are you using? (GLMakie, CairoMakie, WGLMakie, RPRMakie)
- [ ] Please provide an minimal example of the failing code. If the problem is with the visualization, please provide a picture or video of it.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Documentation
about: Report missing or incorrect documentation.
title: ''
labels: documentation
assignees: ''
---

For missing Documentation:
- [ ] What version of Makie are you running? (`]st -m Makie`)
- [ ] What topic, feature, Julia object or function is missing documentation?
- [ ] What information do you expect the documentation to provide? / Why were you looking for it?

For incorrect Documentation
- [ ] What version of Makie are you running? (`]st -m Makie`)
- [ ] Please provide a link to the page/section or name the Julia object/function that has incorrect documentation.
- [ ] Please explain what is incorrect.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

### Feature description
Expand Down
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/regression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Regression
about: Something that used to work but doesn't anymore
asinghvi17 marked this conversation as resolved.
Show resolved Hide resolved
title: ''
labels: regression
assignees: ''
---

- [ ] What version of Makie are you running? (`]st -m Makie`)
- [ ] What is the last Makie version this feature worked on?
- [ ] can you reproduce the bug with a fresh environment ? (`]activate --temp; add Makie`)
- [ ] Which backend are you using? (GLMakie, CairoMakie, WGLMakie, RPRMakie)
- [ ] What platform + GPU are you on?
- [ ] Please provide an minimal example of the failing code. If the problem is with the visualization, please provide a picture or video of it.
12 changes: 5 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@

## Issues

Issues should be used to report bugs, regressions, missing documentation or other things we can act on.
For questions, feature requests, planning and other open ended posts, please use [Discussions](https://github.com/MakieOrg/Makie.jl/discussions).

Before filing an issue please
- check that there are no similar existing issues already
- check that there are no similar existing issues already (feel free to bump an existing one)
- check that your versions are up to date
- you can do this by forcing the latest version using `]add Makie@newest-version`, where `newest-version` can be found on the [releases page](https://github.com/MakieOrg/Makie.jl/releases).

If you want to report a bug, include your version and system information, as well as stack traces with all relevant information.
If possible, condense your bug into the shortest example possible that the maintainers can replicate, a so called "minimal working example" or MWE.

If you want to report a visual regression, include an image showing the faulty behavior.

If you want to suggest a new feature, for example functionality that other plotting packages offer already, include supplementary material such as example images if possible, so it's clear what you are asking for.
When filing an issue, please use one of the templates we provide and follow the given instructions.

## Pull requests

Expand Down
Loading