spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment
https://docs.spyder-ide.org
MIT License
33 stars 283 forks source link

PR: Adapt plugin workshop to the most recent version of cookiecutter #301

Closed map0logo closed 2 years ago

map0logo commented 2 years ago

Pull Request

Pull Request Checklist

Description of Changes

This PR adapts the plugin development workshop to the latest version of cookiecutter, adding links to an updated version of the plugin repository.

Issue(s) Resolved

Adapts the plugin development workshop to the latest version of cookiecutter. This PR is not linked to any previous issue.

Note

The only new commit is the last one, at this point it is easier to squash from github because it was not done locally.

CAM-Gerlach commented 2 years ago

Okay, had to fix a few broken links in the workshops too, but all done now! We just need to rebase in the fixes and resolve the borked branch issue. (As a quick FYI, to avoid lots of spurious merge commits and a complicated, hard to rebase and clean up commit history, we ask that you always use git rebase master rather than git merge master to update your branches to reflect the latest commits on master). I've tested the following options locally and they all work.

If you want to fix this yourself on this branch/PR (be aware, the current detailed, if highly convoluted commit history will no longer be directly available if so, in case that is important to you), run the following git commands:

git switch master
git fetch --all && git reset --hard upstream/master
git push -f
git switch workshops
git reset --hard master
git cherry-pick dc22618a939f1a354501052d86f6b8ed4fdd3fae
git push -f

I'm happy to do this for you, so long as you're okay with me rebasing the branch on your fork.

Alternatively, if you want to keep your existing workshops branch in case you ever might want to refer to the detailed commits for whatever reason (so long as you remember to always create a new fresh branch off master when creating a new PR), you can do this in a new branch and submit a PR based on that:

git switch master
git fetch --all && git reset --hard upstream/master
git push -f
git switch -c update-plugin-workshop-cookiecutter
git cherry-pick dc22618a939f1a354501052d86f6b8ed4fdd3fae
git push -u origin update-plugin-workshop-cookiecutter
# Make a new GitHub PR against the above branch and close this one

Just let me know which option is best for you, or reach out here or on Gitter if you have any questions!

map0logo commented 2 years ago

Hi @CAM-Gerlach, thank you very much for your time and attention. I have no need or interest in preserving the history of the workshops branch. The truth is that I have other things to do and I usually use the default Github options. It's also obvious that I don't intend to leave anything broken in the repository, so the first option is fine for me.

I will follow the instructions you suggest.

CAM-Gerlach commented 2 years ago

(BTW, sorry for the accidental QtPy invite; I was checking to be sure you were a collaborater here and didn't see your name, and somehow didn't realize I was on QtPy instead)

map0logo commented 2 years ago

Thanks a lot @CAM-Gelach, I'll take it into account.

El lun, 6 de dic. de 2021 a la(s) 18:13, CAM Gerlach ( @.***) escribió:

@.**** approved this pull request.

Great, LGTM @map0logo https://github.com/map0logo ! Just FYI, given the trivial review commits with duplicate messages, we'll squash merge this per our new formal policy, as I believe you're familiar with before working with Carlos. In the future, you can use the "batch commits" feature to commit reviewer suggestions all at once with a descriptive, unique commit message if you'd prefer so we can retain your commits, though we're happy to continue squashing and taking care of that ourselves. Thanks!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/spyder-ide/spyder-docs/pull/301#pullrequestreview-824542143, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABZWPYJEK2FGZ55UYRV44TUPUYSFANCNFSM5JIR5PSA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

--

@. @.

cel: +58 +424 7228252 tel: +58 +274 6352001


Debemos ser libres, no para hacer lo que nos plazca, sino libres para comprender muy profundamente nuestros propios instintos e impulsos. K