docs: add repository anatomy section to contribute-to-precice page#844
Open
praaatap wants to merge 1 commit intoprecice:masterfrom
Open
docs: add repository anatomy section to contribute-to-precice page#844praaatap wants to merge 1 commit intoprecice:masterfrom
praaatap wants to merge 1 commit intoprecice:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Description: Add Repository Anatomy to preCICE Contributing Guide
Title:
docs: add repository anatomy section to contribute-to-precice pageDescription:
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/precicecore code repository structure to help new contributors understand the code structure and the whereabouts of specific functionalities.Key Changes:
src/modularization: An explanation of every singlesrc/subdirectory has been provided, includingacceleration,com,mapping,mesh, etc.tests/,docs/,cmake/,tools/,benchmarks/,examples/,extras/,thirdparty/, and.github/directories has been provided.developandmainbranch usage 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