search

JuliaRegistries / RegistryCI.jl

Continuous integration (CI) tools for Julia package registries, including registry consistency testing, automatic merging (automerge) of pull requests, and automatic TagBot triggers
https://juliaregistries.github.io/RegistryCI.jl/stable
Other
31 stars 30 forks source link

try adding an "extended explanation" to compat bounds #566

Closed ericphanson closed 2 months ago

ericphanson commented 2 months ago

Adding an example Project.toml was suggested on Slack by @leonbello to help newcomers see exactly what we're talking about in the message. Here, I've tucked it under an "extended explanation" but we could also just have much longer explanations in the main text.

See here for an example of how it looks

ericphanson commented 2 months ago

I think this is an improvement on the status quo, so I'll merge and tag but I'm happy to continue adjusting this text or style in followup PRs if there's post-merge feedback.

DilumAluthge commented 2 months ago

LGTM.

DilumAluthge commented 2 months ago

In addition to linking to the Pkg docs, can we also link to https://juliaregistries.github.io/RegistryCI.jl/stable/guidelines/#Upper-bounded-%5Bcompat%5D-entries?