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

Ready for 0.1.3 PyPI/GitHub release #113

Closed
7 tasks done
yucongalicechen opened this issue Oct 23, 2024 · 12 comments
Closed
7 tasks done

Ready for 0.1.3 PyPI/GitHub release #113

yucongalicechen opened this issue Oct 23, 2024 · 12 comments

Comments

@yucongalicechen
Copy link
Collaborator

yucongalicechen commented Oct 23, 2024

Release checklist for GitHub contributors

  • All PRs/issues attached to the release are merged.

  • All the badges on the README are passing.

  • License information is verified as correct. If you are unsure, please comment below.

  • Locally rendered documentation contains all appropriate pages, including API references (check no modules are
    missing), tutorials, and other human written text is up-to-date with any changes in the code.

  • Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated and
    tested

  • Successfully run any tutorial examples or do functional testing in some other way.

  • Grammar and writing quality have been checked (no typos).

  • Comment 1: There are a couple issues mostly on improving usability of the package (see https://github.com/diffpy/diffpy.labpdfproc/issues. I think they are probably not necessary for this release).

  • Comment 2: API's working and updated. The description for the main module and the data folder (that contains the data for quick calculation) is empty. Shall we add something? See the attachments here.

image1
image2

@sbillinge ready for review. I can close the two bullet points above after you reviewed the comments.

@sbillinge
Copy link
Contributor

OK, I reviewed the comments and we will make a new release milestone for 0.2.0 and attach issues, but none to do for this one.

@sbillinge
Copy link
Contributor

OK, release should have been sent to pypi. Please check. Also do conda-forge workflow

@yucongalicechen
Copy link
Collaborator Author

The released package is working! I'll check with Bob for the conda-forge workflow.

@bobleesj
Copy link
Contributor

@yucongalicechen Great, please follow the updated GitLab!

@bobleesj
Copy link
Contributor

@yucongalicechen Also please feel free to suggest any feedback/improvement on our new release workflow. Any comment is appreciated.

@yucongalicechen
Copy link
Collaborator Author

screenshot-getting-started
Follow readme instructions for testing -- app works well

@bobleesj
Copy link
Contributor

Congrats on your first successful release on conda-forge

@sbillinge
Copy link
Contributor

Nice, but why are you not entering your name in the global config file?

This is a diffpy.utils issue, but it seems to me that if it were easier for you to do that, and if the instructions were better, you would just do that, right? But now you are not sure what to do and how to do it and it is too difficult so you just ignore the warning?

Please can you make an issue on diffpy.utils to fix that?

But otherwise, congrats, this is great!

@yucongalicechen
Copy link
Collaborator Author

Nice, but why are you not entering your name in the global config file?

This is a diffpy.utils issue, but it seems to me that if it were easier for you to do that, and if the instructions were better, you would just do that, right? But now you are not sure what to do and how to do it and it is too difficult so you just ignore the warning?

Please can you make an issue on diffpy.utils to fix that?

But otherwise, congrats, this is great!

I think the instructions from diffpy.utils is okay. I was testing one possibility where the user did not enter username/email - they are allowed to do that, right? But maybe we can add examples in the "getting started" section so that users know what to enter/expect.

@sbillinge
Copy link
Contributor

Nice, but why are you not entering your name in the global config file?
This is a diffpy.utils issue, but it seems to me that if it were easier for you to do that, and if the instructions were better, you would just do that, right? But now you are not sure what to do and how to do it and it is too difficult so you just ignore the warning?
Please can you make an issue on diffpy.utils to fix that?
But otherwise, congrats, this is great!

I think the instructions from diffpy.utils is okay. I was testing one possibility where the user did not enter username/email - they are allowed to do that, right? But maybe we can add examples in the "getting started" section so that users know what to enter/expect.

people don't really read documentation, so instructions in the warning message are better. Also, no-one would know that when they run labpdfproc that they should look in the docs for diffpy.utils.....not exactly intuitive...so this is the issue that we want to fix

@yucongalicechen
Copy link
Collaborator Author

Nice, but why are you not entering your name in the global config file?
This is a diffpy.utils issue, but it seems to me that if it were easier for you to do that, and if the instructions were better, you would just do that, right? But now you are not sure what to do and how to do it and it is too difficult so you just ignore the warning?
Please can you make an issue on diffpy.utils to fix that?
But otherwise, congrats, this is great!

I think the instructions from diffpy.utils is okay. I was testing one possibility where the user did not enter username/email - they are allowed to do that, right? But maybe we can add examples in the "getting started" section so that users know what to enter/expect.

people don't really read documentation, so instructions in the warning message are better. Also, no-one would know that when they run labpdfproc that they should look in the docs for diffpy.utils.....not exactly intuitive...so this is the issue that we want to fix

Got it, I'll open an issue in diffpy.utils then.

@yucongalicechen
Copy link
Collaborator Author

Opened a new issue here: diffpy/diffpy.utils#129.

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

3 participants