-
Notifications
You must be signed in to change notification settings - Fork 17
Add information about software design page #374
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
Conversation
- Updated categories - Reworded introductory and some other paragraphs - Fixed a yypo - Standardized callout formatting
edvinskis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks for this high-quality PR! I made a few minor revisions (updated categories, reworded introductory and some other sentences, fixed a typo, and standardized callout formatting).
I'll merge it now!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive software design guide focused on research software development. It introduces a new documentation section covering practical approaches to software architecture design, emphasizing principles specific to research contexts like reproducibility, transparency, and scientific collaboration.
Key changes include:
- Created a complete software design guide with step-by-step implementation approach
- Integrated the C4 modeling framework for documenting software architecture at multiple levels
- Added extensive resources and references for further learning
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs/software/development_workflow/software_design.qmd |
New comprehensive guide covering software design principles, step-by-step implementation, and C4 modeling approach |
docs/software/development_workflow/index.md |
Added feature section linking to the new software design guide |
_quarto.yml |
Updated navigation to include the new software design page in the development workflow section |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
I added a new section about software design, the information is at a high level and focuses on research software. It includes:
Closes #233