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

JOSS REVIEW: Community guidelines #287

Closed
3 tasks done
willu47 opened this issue Jan 27, 2025 · 1 comment
Closed
3 tasks done

JOSS REVIEW: Community guidelines #287

willu47 opened this issue Jan 27, 2025 · 1 comment

Comments

@willu47
Copy link

willu47 commented Jan 27, 2025

Part of JOSS REVIEW

  • There are broken links in the CONTRIBUTING.md file. Neither of the links in the how to contribute section work (these sections work in the documentation, I guess because the file is inserted into the relevant section).
  • There are no instructions on how to make a release or to deploy the package to PyPi (essential docs for maintainers)
  • Coupled with the above, I strongly encourage setting up a continuous deployment pipeline for deploying the package to PyPi pushing a tag (or making a release on Github), which greatly eases the process!
@mastoffel mastoffel mentioned this issue Feb 5, 2025
@mastoffel
Copy link
Collaborator

The links are fixed, there is now a release section in the docs, and we've added a gh-actions workflow to automate the release upon pushing a tag, thanks for the suggestion @willu47!

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

No branches or pull requests

2 participants