Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Reference rust doc style guide in contributing guidelines #2452

Merged
merged 6 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
## Change checklist

- [ ] Self-review.
- [ ] Documentation updates if relevant.
- [ ] Documentation updates following the [style guide][https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text], if relevant.
flub marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Code contributions to Iroh are greatly appreciated. Here is the general workflow

- **General code guidelines**

- When possible, please document relevant pieces of code. If documentation refers to another object (module, function, struct, etc) use ``[`path::to::ReferencedObject`]`` to link it. For more information check the [rustdoc docummentation][rustdoc]
- When possible, please document relevant pieces of code following the [rust documentation conventions][docconventions]. For more information on how the rust documentation system works check the [rustdoc docummentation][rustdoc].
- Comment your code. It will be useful for your reviewer and future contributors.

- **Pull request titles**
Expand Down Expand Up @@ -100,3 +100,4 @@ Code contributions to Iroh are greatly appreciated. Here is the general workflow
[forkiroh]: https://github.com/n0-computer/iroh/fork
[draftprs]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
[rustdoc]: https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html
[docconventions]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
Loading