Skip to content

Commit

Permalink
docs: Reference rust doc style guide in contributing guidelines (#2452)
Browse files Browse the repository at this point in the history
## Description

It is good for us to follow the common rust documentation style guide,
so explicitly reference this guide.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

I'm effectively introducing a new policy here.  Feel free to discuss.

## Change checklist

- [x] Self-review.
- [x] Documentation updates if relevant.
- ~~[ ] Tests if relevant.~~
- ~~[ ] All breaking changes documented.~~

---------

Co-authored-by: Franz Heinzmann <[email protected]>
  • Loading branch information
flub and Frando authored Jul 4, 2024
1 parent 13ccc8c commit d4c43c0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
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://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant.
- [ ] 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://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text

0 comments on commit d4c43c0

Please sign in to comment.