matthew-brett / delocate

Find and copy needed dynamic libraries into python wheels
BSD 2-Clause "Simplified" License
262 stars 59 forks source link

Move maintainers guide into CONTRIBUTING.md and add PR templates #217

Closed HexDecimal closed 3 weeks ago

HexDecimal commented 1 month ago

I keep having to repeat myself in PR's since I never got around to making a PR template. I've now added a PR checklist for the most important topics. Relevant for #125

I've updated the CONTRIBUTING.md file with more guidelines. Some of these might be opinionated, but it's mostly stuff I've talked about in PR's or thought of talking about.

The doc directory only included the release guide. I've merged this into CONTRIBUTING.md which is a more appropriate place for that kind of documention. This removes the doc directory since there are no more files left in it.

Removed release steps on manually testing before a release because CI handles these tests automatically. Release guide now suggests making a PR for updates and using the tests from those.

Removed mention of make doctest. Whatever tools this relied on were never set up. Nothing was in the doc directory to be tested.

Release guide no longer suggests adding a signature. The idea of signatures being useful in this context is outdated. See #196 for a more realistic way of making releases more secure.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.95%. Comparing base (f6af445) to head (f6100f0).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #217 +/- ## ======================================= Coverage 96.95% 96.95% ======================================= Files 15 15 Lines 1282 1282 ======================================= Hits 1243 1243 Misses 39 39 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.