Skip to content

skpkg: migrate documentation, README, and public static files - #153

Merged
sbillinge merged 6 commits into
diffpy:migrationfrom
zmx27:doc
Jun 17, 2025
Merged

skpkg: migrate documentation, README, and public static files#153
sbillinge merged 6 commits into
diffpy:migrationfrom
zmx27:doc

Conversation

@zmx27

@zmx27zmx27 commented Jun 16, 2025

Copy link
Copy Markdown
Contributor

No description provided.

@zmx27
zmx27 changed the base branch from main to migrationJune 16, 2025 20:11
@codecov

codecovBot commented Jun 16, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (migration@0db4c3e). Learn more about missing BASE report.

Additional details and impacted files
@@ Coverage Diff @@## migration #153 +/- ##
============================================
Coverage ? 91.96% ============================================
Files ? 7 Lines ? 112 Branches ? 0 ============================================
Hits ? 103 Misses ? 9 Partials ? 0
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

zmx27
zmx27 commented Jun 16, 2025
View reviewed changes
Comment threadREADME.rst
sbillinge
sbillinge reviewed Jun 16, 2025
View reviewed changes

@sbillingesbillinge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looking good, please see my comments. For the "news" we only need to mention the skpkg level 5 one time, not in all the PRs. Other than that one time, we want all the other PRs to be the "no news" news

Comment threadCHANGELOG.rst
Comment threadLICENSE.rst Outdated
Comment threadREADME.rst Outdated
Comment threadREADME.rst
Comment threadREADME.rst
Comment threaddoc/source/index.rst
@@ -1,91 +1,56 @@
Welcome to SNMF's Documentation!

@sbillingesbillingeJun 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

here also, just move the old file over to the new proejct so wee keep everything. I don't think there is anything we need from the new template.

Comment threaddoc/source/index.rst
=======
Authors
-------
=======

@sbillingesbillingeJun 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maybe make this change after you move over the old file

Comment threaddoc/source/index.rst
=======
Indices
-------
=======

@sbillingesbillingeJun 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

and this change

Comment threaddoc/source/index.rst
file included with the distribution.

To get started, please go to :ref:`quick_start`
================

@sbillingesbillingeJun 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

and add this Acknowledgements section to the new doc.

Comment threaddoc/source/license.rst Outdated

Copyright (c) 2023-2024, The Trustees of Columbia University in
the City of New York.
Copyright (c) 2025, The Trustees of Columbia University in the City of New York.

@sbillingesbillingeJun 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

extend the dates

@zmx27
zmx27 marked this pull request as ready for review June 16, 2025 21:34
@zmx27

zmx27 commented Jun 16, 2025

Copy link
Copy Markdown
ContributorAuthor

@sbillinge what do you mean by this? I think that this is the only time I added the news file mentioning that this is now at level 5 skpkg standard.

For the "news" we only need to mention the skpkg level 5 one time, not in all the PRs. Other than that one time, we want all the other PRs to be the "no news" news

Other than that, this is ready for review.

@sbillinge
sbillinge merged commit 4ebfac6 into diffpy:migrationJun 17, 2025
@sbillinge

sbillinge commented Jun 17, 2025

Copy link
Copy Markdown
Contributor

great work! Nicely done there.

@zmx27

zmx27 commented Jun 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@sbillinge I just checked everything over and I think the migration of this package is finished. Please make a PR to merge the migration branch into main and close #147!

@sbillinge

sbillinge commented Jun 17, 2025

Copy link
Copy Markdown
Contributor

Please expand s bit on "I think it is..." What tests did you do and how did they turn out?

@zmx27

zmx27 commented Jun 18, 2025

Copy link
Copy Markdown
ContributorAuthor

I have checked that there are no issues with any of the files we migrated, and all of the tests passes when running pytest in the terminal.

@sbillinge

sbillinge commented Jun 18, 2025

Copy link
Copy Markdown
Contributor

I have checked that there are no issues with any of the files we migrated, and all of the tests passes when running pytest in the terminal.

Thanks. This is what I need. This is much more informational than saying "I think it is ok". @bobleesj sometimes pastes a screenshot of the passing tests which is confidence inspiring. Not for diffpy.snmf, but it is also confidence inspiring if you run one or two tutorial examples if they exist in teh docs, or run some old project file, or have one of your group-member colleagues who has used a package to quickly rerun their old analysis to make sure it behavies the same way, things like that. Thanks so much!

sbillinge added a commit that referenced this pull request Jun 18, 2025
@sbillinge@zmx27@pre-commit-ci
Migration into main (#154)
3af38ad
* skpkg: setup CI after migrating tests, src, requirements, and .github folder (#151)
* skpkg: migrate src folder
* skpkg: migrate tests folder
* skpkg: list dependencies in requirements folder
* skpkg: add CI and issue/PR templates
* skpkg: add pyproject.toml
* skpkg: standardize files by removing examples and adding back necessary scripts
* skpkg: modify copyright years and contributors in a missed file
* style: changed line length to 115 and ran pre-commit again
* fix: testing if adding .github/workflow will pass CI
* [pre-commit.ci] auto fixes from pre-commit hooks
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* skpkg: add configuration files for pre-commit, readthedocs, codecov (#152)
* skpkg: add config files for pre-commit
* skpkg: add config files readthedocs, codecov, GitHub
* style: remove stashed change indicators and modify code of conducts to pass pre-commit
* skpkg: migrate documentation, README, and public static files (#153)
* skpkg: migrate documentation
* skpkg: add config files for authors, changelog, code of conduct, license
* skpkg: add README.rst
* skpkg: add news files
* chore: add back necessary lines from the files
* chore: fix files according to comments in the review
---------
Co-authored-by: zmx27 <95781012+zmx27@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sbillingesbillingesbillinge left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@zmx27@sbillinge