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

Add CONTRIBUTING Guide #177

Closed elsiehupp closed 11 months ago

elsiehupp commented 11 months ago

Considering the frustrations with our development process, I figured it was well past time to put together a written set of best practices.

This Pull Request partially addresses @NyaMisty's Issue https://github.com/mediawiki-client-tools/mediawiki-scraper/issues/82 (but not fully), so @mediawiki-client-tools @yzqzss everyone please do comment on this and make or suggest any changes.

(I am marking as a draft in order to give everyone time to respond before this gets merged.)

Note that as @robkam mentioned, the "Code of Conduct" is kind of a separate Issue from the "Contributing" guide; I can open a Pull Request for that next.

robkam commented 11 months ago

I'm not sure what's meant on line 55 by "You don't have to do so up front, but we ask that you do so when you...". Otherwise it looks fine.

elsiehupp commented 11 months ago

I'm not sure what's meant on line 55 by "You don't have to do so up front, but we ask that you do so when you...". Otherwise it looks fine.

It means "You don't have to do so up front, but we ask that you [follow these best practices for writing a commit message] when you [open a pull request]," but, yeah, the wording is a bit awkward...

(By the way, you should be able to make commits on this Pull Request yourself, if you'd like to tweak the wording. I did this myself on one of your recent Pull Requests.)

randomnetcat commented 11 months ago

The main substance lgtm. Haven't carefully examined the wording but can do so later.