docs: Revamp CONTRIBUTING.md#833
Merged
RaoulLuque merged 5 commits intopetgraph:masterfrom Jun 23, 2025
Merged
Conversation
starovoid
reviewed
Jun 20, 2025
Collaborator
starovoid
left a comment
There was a problem hiding this comment.
Excellent! I've only come up with one improvement so far.
Member
Author
|
Alright, once the other PR is merged, I'll add a link in the |
Member
Author
|
Just fixed a formatting issue and made it a bit nicer to look at with some emotes. Let me know what you think :) Can also revert it ^^ |
05fd46d to
713ca41
Compare
starovoid
requested changes
Jun 22, 2025
Link to new algodocs template Co-authored-by: Egor Starovoitov <[email protected]>
Member
Author
|
@starovoid , I think you need to re-review or somehow approve the changes because I can't seem to be able to merge before that :) Not sure, but I think otherwise there also is an option to mark a review as something like "if this is done, it can be merged in my opinion". |
starovoid
approved these changes
Jun 23, 2025
Merged
8 tasks
RaoulLuque
added a commit
to RaoulLuque/petgraph
that referenced
this pull request
Sep 21, 2025
This PR revamps the CONTRIBUTING.md. First of all, it switches from .rst to .md, since the latter seems more modern 🌟 Second, it updates the information in the contribution guide since an up-to-date contribution guide should make it more attractive to contribute to the project :) I tried to keep the information there was before and add some new things or update the things that were outdated ^^ In particular, regarding the different kinds of PRs and their requirements, I left the old section in the contribution guide as-is, since I plan to include that information in the PR templates as mentioned in petgraph#811. For one, this resolves petgraph#827, but also checks the last box in petgraph#725. --------- Co-authored-by: Egor Starovoitov <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 30, 2025
## 🤖 New release * `petgraph`: 0.8.2 -> 0.8.3 (✓ API compatible changes) <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.8.3](https://github.com/petgraph/petgraph/compare/[email protected]@v0.8.3) - 2025-09-28 ### Bug Fixes - Infinite `subgraph_isomorphisms_iter` for empty isomorphisms ([#780](#780)) - Algos don't work on `UndirectedAdaptor` ([#870](#870)) ([#871](#871)) - use a queue for SPFA ([#893](#893)) - `StableGraph::reverse` breaks free lists ([#890](#890)) ### Documentation - Fix examples link in README and unify typesetting of one word ([#823](#823)) - Add link to multigraph definition to isomorphism algos ([#824](#824)) - Fix auxiliary space (and time) complexity of bron-kerbosch ([#825](#825)) - Fix Typo in Operator Module Documentation ([#831](#831)) - Sync the crate feature flags in the README and docs ([#832](#832)) - Remove all \[Generic\] tags from algo docstrings ([#835](#835)) - Fix typos in comments ([#836](#836)) - Revamp CONTRIBUTING.md ([#833](#833)) - Update `GraphMap` link in README ([#857](#857)) - Add doc comment for `Dot::with_attr_getters` ([#850](#850)) - Specify iteration order for neighbors and edges and their variants ([#790](#790)) - Collection of Doc fixes ([#856](#856)) ### New Features - Add `into_nodes_edges_iters` to `StableGraph` ([#841](#841)) - Add methods to reserve & shrink `StableGraph` capacity ([#846](#846)) - Add Dinic's Maximum Flow Algorithm ([#739](#739)) - make Csr::from_sorted_edges generic over edge type and properly increase edge_count in Csr::from_sorted_edges ([#861](#861)) - Add `map_owned` and `filter_map_owned` for `Graph` and `StableGraph` ([#863](#863)) - Add dijkstra::with_dynamic_goal ([#855](#855)) - Fix self-loop bug in all_simple_paths and enable multiple targets ([#865](#865)) - mark petgraph::dot::Dot::graph_fmt as public ([#866](#866)) - Add bidirectional Dijkstra algorithm ([#782](#782)) ### Performance - Make A* tie break on lower h-values ([#882](#882)) ### Refactor - add examples for scc algorithms and reorganize into dedicated module ([#830](#830)) - Remove unnecessary trait bounds from impls/methods ([#828](#828)) - replace uses of 'crate::util::zip' with 'core::iter::zip' ([#849](#849)) - Fix clippy (and other) lints ([#851](#851)) - Cleanup repo ([#854](#854)) - replace crate::util::enumerate with Iterator::enumerate ([#881](#881)) ### Testing - Add dependency list for 'quickcheck' feature ([#822](#822)) - Fix feature cfg capitalization in doctest ([#852](#852)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Egor Starovoitov <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR revamps the CONTRIBUTING.md. First of all, it switches from .rst to .md, since the latter seems more modern 🌟
Second, it updates the information in the contribution guide since an up-to-date contribution guide should make it more attractive to contribute to the project :) I tried to keep the information there was before and add some new things or update the things that were outdated ^^
In particular, regarding the different kinds of PRs and their requirements, I left the old section in the contribution guide as-is, since I plan to include that information in the PR templates as mentioned in #811.
For one, this resolves #827, but also checks the last box in #725.