Skip to content

Add code hyperlinking guidelines to CONTRIBUTING.md #243

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add code hyperlinking guidelines to CONTRIBUTING.md #243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.