-
Notifications
You must be signed in to change notification settings - Fork 49
Add Maintainers in Academia page #383
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
Open
cassidoo
wants to merge
1
commit into
main
Choose a base branch
from
cw/academia-maintainers
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+606
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| import fs from 'fs' | ||
| import path from 'path' | ||
| import matter from 'gray-matter' | ||
| import { marked } from 'marked' | ||
|
|
||
| const ACADEMIA_DIRECTORY = path.join(process.cwd(), 'content', 'academia') | ||
|
|
||
| const normalizeMaintainerProfiles = (maintainerProfiles = []) => { | ||
| if (Array.isArray(maintainerProfiles)) { | ||
| return maintainerProfiles.reduce( | ||
| (profiles, entry) => ({ ...profiles, ...entry }), | ||
| {}, | ||
| ) | ||
| } | ||
|
|
||
| if (maintainerProfiles && typeof maintainerProfiles === 'object') { | ||
| return maintainerProfiles | ||
| } | ||
|
|
||
| return {} | ||
| } | ||
|
|
||
| const parsePost = ({ slug, data, content }) => ({ | ||
| slug, | ||
| name: data.name || '', | ||
| institution: data.institution || '', | ||
| department: data.department || '', | ||
| projectName: data.projectName || '', | ||
| projectRepo: data.projectRepo || '', | ||
| projectWebsite: data.projectWebsite || '', | ||
| maintainerProfiles: normalizeMaintainerProfiles(data.maintainerProfiles), | ||
| badges: Array.isArray(data.badges) ? data.badges : [], | ||
| description: data.description || '', | ||
| content, | ||
| }) | ||
|
|
||
| export const getAcademiaPosts = () => { | ||
| if (!fs.existsSync(ACADEMIA_DIRECTORY)) { | ||
| return [] | ||
| } | ||
|
|
||
| return fs | ||
| .readdirSync(ACADEMIA_DIRECTORY) | ||
| .filter((fileName) => fileName.endsWith('.md')) | ||
| .map((fileName) => { | ||
| const slug = fileName.replace('.md', '') | ||
| const markdown = fs.readFileSync( | ||
| path.join(ACADEMIA_DIRECTORY, fileName), | ||
| 'utf-8', | ||
| ) | ||
| const { data, content } = matter(markdown) | ||
|
|
||
| return parsePost({ slug, data, content }) | ||
| }) | ||
| .sort((postA, postB) => postA.projectName.localeCompare(postB.projectName)) | ||
| } | ||
|
|
||
| export const getAcademiaPostBySlug = (slug) => { | ||
| const filePath = path.join(ACADEMIA_DIRECTORY, `${slug}.md`) | ||
|
|
||
| if (!fs.existsSync(filePath)) { | ||
| return null | ||
| } | ||
|
|
||
| const markdown = fs.readFileSync(filePath, 'utf-8') | ||
| const { data, content } = matter(markdown) | ||
| const post = parsePost({ slug, data, content }) | ||
|
|
||
| return { | ||
| ...post, | ||
| htmlContent: marked(post.content), | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| .academia-list { | ||
| padding: spacing(7) spacing(2) 0; | ||
|
|
||
| @media (min-width: $lg) { | ||
| padding-left: spacing(3); | ||
| padding-right: spacing(3); | ||
| } | ||
|
|
||
| &__intro { | ||
| padding: spacing(3); | ||
| margin-bottom: spacing(2); | ||
|
|
||
| h1 { | ||
| @extend %header-2; | ||
| margin-bottom: spacing(1.5); | ||
| } | ||
|
|
||
| p { | ||
| @extend %body-1; | ||
| color: $white-80; | ||
| max-width: 820px; | ||
| } | ||
| } | ||
|
|
||
| &__empty { | ||
| @extend %body-1; | ||
| color: $white-80; | ||
| padding: spacing(3); | ||
| border-top: 1px solid $white-50; | ||
| } | ||
|
|
||
| &__item { | ||
| position: relative; | ||
| padding: spacing(3); | ||
| border-top: 1px solid $white-50; | ||
|
|
||
| @extend %background-filter; | ||
| } | ||
|
|
||
| &__main { | ||
| text-align: right; | ||
|
|
||
| @media screen and (max-width: $xl) { | ||
| text-align: left; | ||
| } | ||
| } | ||
|
|
||
| &__flex { | ||
| display: flex; | ||
| justify-content: space-between; | ||
| flex-wrap: wrap; | ||
| } | ||
|
|
||
| &__flex div, &__flex p { | ||
| max-width: 740px; | ||
| } | ||
|
|
||
| &__title { | ||
| @extend %header-2; | ||
| margin-bottom: spacing(1); | ||
| } | ||
|
|
||
| &__subtitle { | ||
| @extend %header-5; | ||
| margin-bottom: spacing(2); | ||
| } | ||
|
|
||
| &__badges { | ||
| display: flex; | ||
| flex-wrap: wrap; | ||
| gap: spacing(1); | ||
| margin-bottom: spacing(2); | ||
| } | ||
|
|
||
| &__description { | ||
| @extend %body-1; | ||
| color: $white-80; | ||
| margin-bottom: spacing(2.5); | ||
| } | ||
| } | ||
|
|
||
| .academia-post { | ||
| max-width: 920px; | ||
| margin: spacing(6) auto; | ||
| padding: 0 spacing(2); | ||
|
|
||
| @media (min-width: $md) { | ||
| padding: 0 spacing(3); | ||
| } | ||
|
|
||
| @media (min-width: $lg) { | ||
| margin: spacing(8) auto spacing(10); | ||
| padding: 0 spacing(4); | ||
| } | ||
|
|
||
| &__back-link { | ||
| @extend %subtitle-1; | ||
| display: inline-block; | ||
| margin-bottom: spacing(3); | ||
|
|
||
| &:hover { | ||
| text-decoration: underline; | ||
| } | ||
| } | ||
|
|
||
| &__title { | ||
| @extend %header-1; | ||
| margin-bottom: spacing(2); | ||
| } | ||
|
|
||
| &__subtitle { | ||
| @extend %header-5; | ||
| color: $white-80; | ||
| margin-bottom: spacing(3); | ||
| } | ||
|
|
||
| &__divider { | ||
| border: 0; | ||
| border-top: 1px solid $white-50; | ||
| margin: spacing(3) 0; | ||
| } | ||
|
|
||
| &__meta { | ||
| margin: 0; | ||
| } | ||
|
|
||
| &__meta-row { | ||
| display: grid; | ||
| grid-template-columns: 1fr; | ||
| row-gap: spacing(0.5); | ||
| margin-bottom: spacing(2); | ||
|
|
||
| @media (min-width: $md) { | ||
| grid-template-columns: 180px 1fr; | ||
| column-gap: spacing(1); | ||
| align-items: baseline; | ||
| } | ||
|
|
||
| dt { | ||
| @extend %subtitle-1; | ||
| color: $white; | ||
| } | ||
|
|
||
| dd { | ||
| margin: 0; | ||
| @extend %body-1; | ||
| color: $white-80; | ||
|
|
||
| a { | ||
| text-decoration: underline; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| &__badges { | ||
| display: flex; | ||
| flex-wrap: wrap; | ||
| gap: spacing(1); | ||
| } | ||
|
|
||
| &__content { | ||
| @extend %markdown; | ||
| @extend %body-1; | ||
|
|
||
| color: $white-80; | ||
| text-align: justify; | ||
|
|
||
| h1, | ||
| h2, | ||
| h3, | ||
| h4, | ||
| h5, | ||
| h6 { | ||
| font-family: $jetbrains; | ||
| font-weight: $regular; | ||
| color: $white; | ||
| margin: spacing(3) 0 spacing(1.5); | ||
| line-height: 1.5; | ||
| text-align: left; | ||
| } | ||
|
|
||
| h1 { | ||
| font-size: 2rem; | ||
| } | ||
|
|
||
| h2 { | ||
| font-size: 1.75rem; | ||
| } | ||
|
|
||
| h3 { | ||
| font-size: 1.5rem; | ||
| } | ||
|
|
||
| h4, | ||
| h5, | ||
| h6 { | ||
| font-size: 1.25rem; | ||
| } | ||
|
|
||
| p, | ||
| li { | ||
| line-height: 1.8; | ||
| } | ||
|
|
||
| a { | ||
| text-decoration: underline; | ||
| } | ||
| } | ||
|
|
||
| &__footer-links { | ||
| @extend %body-1; | ||
| color: $white-80; | ||
|
|
||
| a { | ||
| text-decoration: underline; | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| name: Dr. Test Tester | ||
| institution: University of Test | ||
| department: Department of Test | ||
| projectName: OpenBiome Test | ||
| projectRepo: https://github.com/test | ||
| projectWebsite: https://github.com | ||
| maintainerProfiles: | ||
| - linkedin: https://www.linkedin.com/in/github/ | ||
| - github: https://github.com/ | ||
| - orcid: https://orcid.org/123456 | ||
| badges: ["Academic Maintainer", "Verified GitHub Teacher"] | ||
| description: "An open source toolkit that helps research labs standardize and analyze environmental microbiome sequencing workflows." | ||
| --- | ||
|
|
||
| (everything below is fake) | ||
|
|
||
| When we started OpenBiome Toolkit, the immediate goal was practical: reduce the time students and researchers spend stitching together fragile scripts for sequencing analysis. | ||
|
|
||
| At first, our lab used separate notebooks and internal utilities that worked for one project, then broke for the next. As collaborators joined from other universities, the friction became obvious. Everyone had slightly different environments, file conventions, and assumptions. | ||
|
|
||
| We decided to build a public, reusable toolkit instead of another private lab pipeline. That shift changed how we think about research software. | ||
|
|
||
| ## Why maintain in the open | ||
|
|
||
| Maintaining an academic open source project means balancing publication cycles, teaching schedules, and community support. | ||
|
|
||
| The open model has still been worth it for three reasons: | ||
|
|
||
| 1. Reproducibility improves when workflows are versioned and visible. | ||
| 2. Students learn software engineering practices in real projects. | ||
| 3. Cross-institution collaboration moves faster when teams share a common baseline. | ||
|
|
||
| ## What the project includes | ||
|
|
||
| OpenBiome Toolkit currently provides: | ||
|
|
||
| - Data validation commands for sequencing metadata before pipeline execution. | ||
| - Reproducible environment setup with pinned dependencies. | ||
| - Starter templates for analysis reports and figure generation. | ||
| - CI checks so new contributions do not silently change outputs. | ||
|
|
||
| ## Challenges we are still solving | ||
|
|
||
| The hardest part is not the code; it is long-term maintenance planning. | ||
|
|
||
| Academic teams naturally rotate as students graduate, and maintainers need clear handoff processes. We now require: | ||
|
|
||
| - Contributor onboarding docs for every subsystem. | ||
| - Monthly triage and issue labeling. | ||
| - Release notes that explain breaking changes in plain language. | ||
|
|
||
| ## Advice for new academic maintainers | ||
|
|
||
| Start smaller than you think. | ||
|
|
||
| A focused, reliable tool that solves one painful workflow step is easier to sustain than a broad platform with unclear boundaries. Once you have users and contributors, scope can grow with real feedback. | ||
|
|
||
| Open source in academia is not just about sharing code. It is about building durable research infrastructure that outlives a single grant cycle. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.