Skip to content

Commit

Permalink
feat: adding contributing guidelines page to website directing team m…
Browse files Browse the repository at this point in the history
…embers to guidelines doc in repo
  • Loading branch information
njlyon0 committed Sep 5, 2024
1 parent abdd568 commit 361b92a
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
15 changes: 15 additions & 0 deletions _freeze/internal_contributing/execute-results/html.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"hash": "40758e5eb4ebe614077eba815c943c8e",
"result": {
"engine": "knitr",
"markdown": "---\ntitle: \"SciComp Team Contributing Guidlines\"\nengine: knitr\n---\n\n\nWhile our team is composed of members from different backgrounds, we strive to adhere to a shared set of contributing and style guidelines. This ensures a consistent \"feel\" of our team's products, regardless of which team member took the lead on a particular task.\n\nStandard convention in GitHub is to house such information in a \"CONTRIBUTING.md\" file in the top-level of the relevant repository. We have done that in the repository underpinning this website but you can also quickly jump to that file by clicking [here](https://github.com/lter/scicomp/blob/main/CONTRIBUTING.md).\n\nNote that these are only required for Scientific Computing team members but you may find some of this guidance helpful even if you're not a part of our team.\n",
"supporting": [],
"filters": [
"rmarkdown/pagebreak.lua"
],
"includes": {},
"engineDependencies": {},
"preserve": {},
"postProcess": true
}
}
2 changes: 2 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ website:
menu:
- text: "People"
href: staff.qmd
- text: "Inernal: Contributing"
href: internal_contributing.qmd
- text: "Internal: Team Onboarding"
href: internal_team-onboard.qmd
- text: "Internal: WG Setup"
Expand Down
10 changes: 10 additions & 0 deletions internal_contributing.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "SciComp Team Contributing Guidlines"
engine: knitr
---

While our team is composed of members from different backgrounds, we strive to adhere to a shared set of contributing and style guidelines. This ensures a consistent "feel" of our team's products, regardless of which team member took the lead on a particular task.

Standard convention in GitHub is to house such information in a "CONTRIBUTING.md" file in the top-level of the relevant repository. We have done that in the repository underpinning this website but you can also quickly jump to that file by clicking [here](https://github.com/lter/scicomp/blob/main/CONTRIBUTING.md).

Note that these are only required for Scientific Computing team members but you may find some of this guidance helpful even if you're not a part of our team.

0 comments on commit 361b92a

Please sign in to comment.