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

Add YAML files for issue tracker #1079

Merged

Conversation

Saransh-cpp
Copy link
Contributor

Addresses #1077

  • Adds a bug report template and a contact link, with everything in YAML!
  • The bug reports will be automatically labelled too!

Try this out here - https://github.com/Saransh-cpp/zarr-python/issues/new/choose

Looks like this -

image

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@joshmoore
Copy link
Member

@Saransh-cpp : would you like to add yourself to docs/release.rst?

Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

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

Screen Shot 2022-07-18 at 18 14 01

versus

Screen Shot 2022-07-18 at 18 14 13

👍

NB: @MSanKeys963, we should probably updated the top text:

For bug reports, please follow the template below. For enhancement proposals, feel free
to use whatever template makes sense (major new features should be discussed in the Zarr specifications repository https://github.com/zarr-developers/zarr-specs).

to include ZEPs.

@Saransh-cpp
Copy link
Contributor Author

Thank for the review, @joshmoore! Should I add this -

For bug reports, please follow the template below. For enhancement proposals, feel free
to use whatever template makes sense (major new features should be discussed in the Zarr specifications repository https://github.com/zarr-developers/zarr-specs).

to the top of the template?

@joshmoore
Copy link
Member

Should I add this ... to the top of the template?

I think it's more something for the config.yaml sending people to https://zarr.dev/zeps/

@Saransh-cpp
Copy link
Contributor Author

I think it's more something for the config.yaml sending people to https://zarr.dev/zeps/

Ah, ZEPs, like PEPs and NEPs, interesting! Updating!

@Saransh-cpp
Copy link
Contributor Author

Updated!

image

@joshmoore
Copy link
Member

Nice! Thanks, @Saransh-cpp. I think @MSanKeys963 has a few minor suggestions for this, but it's looking great. (If you have fun unicodes that you think would be appropriate, feel free. 😄)

@Saransh-cpp
Copy link
Contributor Author

Thank you for the reviews, @jakirkham and @joshmoore! Looks much better now -

image

@joshmoore joshmoore merged commit dcc6ded into zarr-developers:main Jul 21, 2022
@jakirkham
Copy link
Member

Thanks Saransh for the PR and Josh & Sanket for the reviews! 🙏

@Saransh-cpp Saransh-cpp deleted the update-bug-report-template branch July 21, 2022 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants