Skip to content

docs: add repository anatomy section to contribute-to-precice page#844

Open
praaatap wants to merge 1 commit intoprecice:masterfrom
praaatap:fix/sri-hashes
Open

docs: add repository anatomy section to contribute-to-precice page#844
praaatap wants to merge 1 commit intoprecice:masterfrom
praaatap:fix/sri-hashes

Conversation

@praaatap
Copy link
Contributor

PR Description: Add Repository Anatomy to preCICE Contributing Guide

Title: docs: add repository anatomy section to contribute-to-precice page

Description:

This PR adds a comprehensive Repository Anatomy subsection to the "Contributing code" section on the "Contribute to preCICE" page. This section will provide a detailed overview of the precice/precice core code repository structure to help new contributors understand the code structure and the whereabouts of specific functionalities.

Key Changes:

  • Directory Tree Overview: A visual representation of the project root directory has been added.
  • Detailed src/ modularization: An explanation of every single src/ subdirectory has been provided, including acceleration, com, mapping, mesh, etc.
  • Support for Infrastructure: An explanation of the tests/, docs/, cmake/, tools/, benchmarks/, examples/, extras/, thirdparty/, and .github/ directories has been provided.
  • Root-level Reference: An explanation of the root-level configuration files has been provided, including CMake configuration, formatting, and CI scripts.
  • Branching Model: An explanation of the develop and main branch usage has been provided.
  • Ecosystem Links: An explanation of the core library's relation to the larger preCICE organization has been provided.

Impact:
This will increase transparency and help new contributors overcome the entry barrier.

Modified File:

  • content/community/contribute/community-contribute-to-precice.md

@MakisH MakisH added GSoC Contributed in the context of the Google Summer of Code content Content-only issues labels Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Content-only issues GSoC Contributed in the context of the Google Summer of Code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants