rust-itertools / itertools

Extra iterator adaptors, iterator methods, free functions, and macros.
https://docs.rs/itertools/
Apache License 2.0
2.72k stars 309 forks source link

Create `CONTRIBUTING.md` #767

Closed Philippe-Cholet closed 8 months ago

Philippe-Cholet commented 1 year ago

Fixes #756

As mentioned in the issue, I did not write anything related to testing yet, as I think we should clarify what's expected of contributors.

Rendered here

Philippe-Cholet commented 8 months ago

I finally mentionned tests and benchmarks.

jswrenn commented 8 months ago

Mark this 'ready for review' whenever you feel it's ready to be merged!

Philippe-Cholet commented 8 months ago

I squashed my commits, I think it's a decent initial CONTRIBUTING.md that we will ocasionally update.

CI is blocked since #805. I'm not sure what to do apart from removing the paths-ignore: I added in there.

jswrenn commented 8 months ago

Oh, huh. That's a funny situation.

I think we can fix this by adding a no-op job that always succeeds, and have all-jobs-succeed depend on it.

codecov[bot] commented 8 months ago

Codecov Report

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

Comparison is base (6814180) 94.38% compared to head (362669e) 94.38%.

:exclamation: Current head 362669e differs from pull request most recent head 5fe6223. Consider uploading reports for the commit 5fe6223 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #767 +/- ## ======================================= Coverage 94.38% 94.38% ======================================= Files 48 48 Lines 6665 6665 ======================================= Hits 6291 6291 Misses 374 374 ```

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

jswrenn commented 8 months ago

Hm, never mind. That won't help. Honestly, it might just be easiest for me to bypass branch protections for these cases.