How romenrg/evergreen-skills-developers works
Project type and purpose
• This is a documentation-only, open-source knowledge base (“evergreen skills” for software developers) rather than a running application.
• Purpose: serve as a canonical list of cross-framework, language-agnostic technical and non-technical skills to guide technical interviews and self-study.
File structure
• Top-level files:
• README.md – main content.
• CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE, changelog.md – governance and versioning.
• .github/ – community workflows (issue & PR templates, funding).
• .spelling – custom dictionary for linting markdown.
• No src/ or bin/ folders – no application code, only markdown docs.
• CI integration: badge in README references Codeship.
README for additional insights
• It describes the content hierarchy (non-technical vs technical skills, sub-topics).
• Mentions contributions workflow and that it’s WIP.
a. Main components
• Author/Contributor (Dev)
• GitHub repository (content store)
• CI pipeline (Codeship)
• Publishing layer (e.g. GitHub Pages or other static-site host)
• Community feedback channels (Issues, PRs)
b. Relationships & interactions
• Dev forks/clones → edits markdown → pushes branch → opens PR
• GitHub triggers Codeship CI → runs markdown linting/spelling checks → returns status
• On merge to master → GitHub Pages automatic rebuild & deploy (or manual deploy via CI)
• Community interacts via issues/templates → triggers notifications → backlog
c. Architectural patterns/principles
• “Docs as code”: treat markdown files in Git as source.
• Continuous Integration for linting and quality.
• Pull Request reviews for quality control and governance.
• Immutable artifacts: each commit maps to a versioned document.
d. Key technologies
• Git & GitHub for version control and hosting.
• Codeship for CI checks (spelling, markdown lint).
• Markdown as source format.
• GitHub Pages (or equivalent SSG) for static site hosting.
Details to capture
• Issue & PR templates enforcing contribution standards.
• Spelling/grammar checks via .spelling config.
• Changelog tracking for releases.
• License & code-of-conduct as governance artifacts.