search

opws / opws-dataset

Profiles for the user account systems of various sites.
Open Data Commons Open Database License v1.0
14 stars 2 forks source link

Standardizing commit / pull request title format #279

Closed stuartpb closed 6 years ago

stuartpb commented 7 years ago

So yeah, I'm trying to ascertain the last time I reviewed profiles before I introduced the reviewed.date field right now, and holy cow this would be easier if commits had used some kind of filterable syntax so I could tell when I was just updating a profile's structure and when I was actually reviewing its data.

I mean, it's not like it's that hard, because there are only a handful of commits that keep coming up for all the big refactors so I know what they look like, and I pretty much never reviewed profiles before I introduced reviewed.date (and that notion is why I introduced the field), but I shudder to imagine how bad things could get in the future if this isn't taken care of soon.

While this may theoretically be possible by just filtering if a commit touched the reviewed.date field lines or something, I think it'd be a lot easier in the future if I institute a dang policy like the big projects have, where commits have to start with something like [add] or [review] or [refactor] or [misc] (or maybe just the words "Profile" or "Review" or "Move" (or something else that describes "adding legacy"), and tags can be for the other kinds of major commit) and then CI rejects any commits that don't have one of those.

Also, for CI, I'm thinking of having a pair of scripts, ci/setup.sh and a ci/test.sh, that'll run all the tests for this repo (after #147).

stuartpb commented 7 years ago

I'm actually going to go ahead and steal that "ci directory" idea now, ahead of #147 (or, technically, as part of it, with #146).

stuartpb commented 6 years ago

Continuing discussion in opws/opws-guidelines#7.