Skip to content

Commit fae21e8

Browse files
authored
Merge pull request #184 from UCD-SERG/copilot/add-copilot-instructions-guidance
Add UCD-SeRG Lab Manual reference to copilot-instructions
2 parents 13dcf54 + 614d8b0 commit fae21e8

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@
1010
- **Key Dependencies**: runjags, rjags, JAGS 4.3.1, serocalculator, ggmcmc, dplyr, ggplot2
1111
- **Lifecycle**: Experimental (under active development)
1212

13+
## Lab-Wide Guidance
14+
15+
**Follow the guidance in the [UCD-SeRG Lab Manual](https://ucd-serg.github.io/lab-manual/)**, which provides comprehensive best practices for:
16+
- Culture and conduct
17+
- Communication
18+
- Reproducibility
19+
- Code repositories and version control
20+
- Coding practices and style
21+
- Working with big data
22+
- Quarto and documentation
23+
- GitHub workflows
24+
- Reproducible environments
25+
- Code and data publication
26+
- AI tools usage
27+
- And more
28+
29+
If the web version is inaccessible, refer to the [source files on GitHub](https://github.com/UCD-SERG/lab-manual) for easier reading.
30+
1331
## Critical Setup Requirements
1432

1533
### Copilot Setup Workflow (Automatic Environment Configuration)

NEWS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
Workspace sessions much faster.
3737
* Reorganized pkgdown documentation with new "Getting Started" guide demonstrating main API workflow, organized articles into "Get started" and "Developer Notes" sections (#73).
3838
* Added `.github/workflows/copilot-setup-steps.yml` GitHub Actions workflow to automate environment setup for GitHub Copilot coding agent, preinstalling R, JAGS, and all dependencies.
39+
* Added reference to UCD-SeRG Lab Manual in copilot-instructions for lab-wide best practices guidance.
3940

4041
* Consolidated OS-specific snapshot variants: removed redundant Linux and Windows
4142
snapshot directories (which were identical), keeping only base snapshots and

0 commit comments

Comments
 (0)