From 6a66f7f4899cbc4e263c0def5935e68c8640213c Mon Sep 17 00:00:00 2001 From: raiyyan Date: Sun, 5 Oct 2025 06:07:06 +0530 Subject: [PATCH] Add code hyperlinking guidelines to CONTRIBUTING.md Added a 'Code Hyperlinks' section explaining when to use GitHub permalinks for code blocks/highlighting and when to use source links. This should help contributors provide clearer references in docs and reviews. --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cccefafe..16caced1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,3 +9,13 @@ You can also suggest changes by editing the .Rmd files that are at the root of t ## With write access You can push directly to `main` for small fixes. Please use PRs to `main` for discussing larger updates - try to limit to one section or at least one chapter in each PR, so that changes are easier to review. + +### Code Hyperlinks + +When referencing code in documentation, issues, or pull requests: + +- If you need to show a code block or highlight specific lines, use a GitHub mirror permalink (with line highlighting). + +- For general references where highlighting is not needed, you may use the original source link. + +This helps reviewers and readers quickly see the relevant code in context.