mediawiki-client-tools / mediawiki-dump-generator

Python 3 tools for downloading and preserving wikis
https://github.com/mediawiki-client-tools/mediawiki-scraper
GNU General Public License v3.0
89 stars 14 forks source link

Update README.md #168

Closed robkam closed 12 months ago

robkam commented 1 year ago

add pip instructions for Windows command prompt

elsiehupp commented 12 months ago

One other quick comment, @robkam—if possible, could you try using more descriptive branch names? e.g. something like update-windows-instructions rather than robkam-patch-1.

Most of the time the generic branch name is fine, but on certain occasions it can be helpful to have something more easily recognizable.

(Also just FYI you can change a branch name after you create it, but if you change a branch name after starting a Pull Request, the original Pull Request gets automatically closed, and you have to open another Pull Request for the new branch name. I learned this from experience elsewhere!)

(Also FYI if you're not familiar with how Git works, "local" and "remote" branches that track each other can have different names. So if you rename a branch on a cloned repository it's easiest if you rename it before "publishing" it. This shouldn't be an issue if you're just working in the GitHub web interface, though.)

robkam commented 12 months ago

Okay, I'll try to do do more descriptive branch names in future. I'm just using GitHub web.

elsiehupp commented 12 months ago

Okay, cool!

And yeah the username-patch-1 branch names are a GitHub web thing. (It's mildly annoying that they don't prompt you to enter a more descriptive branch name.)

Anyway if you need any instructions on how to work with branches directly, just let me know!

elsiehupp commented 12 months ago

You probably already figured this out, but I went through the steps myself, and it looks like this is where you have the opportunity to choose a branch name:

Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4

Anyway we should probably create a CONTRIBUTING guide, as well...

robkam commented 12 months ago

Yeah, it's easy to change the branch name. Only I never thought it was important enough to do, especially when the commit is already called 'Update readme', but I see other contributors are using meaningful branch names.

Apparently both mediawiki-scraper and wikitools3 should have

elsiehupp commented 12 months ago

I was thinking… to be honest I spend all of 5s on branch names myself, so, to be fair, a branch name like whoopsie-typo is perfectly fine… it's memorable in the short term, and it gets the point across. So, no need to sweat over it too much! 😅