跳到正文
cccskills
免费在 GitHub 公开

rseng-project-scaffolding

Covers starting research software projects from maintained templates and keeping them in sync: choosing a generator (Copier, cookiecutter), scaffolding a Python package, retrofitting template structure, pulling template upgrades into generated projects, and picking a pyproject build backend. Use when the user starts a new research software codebase, asks for a template or boilerplate, wants a src/ layout or pyproject.toml scaffold, mentions copier or cookiecutter, or chooses between setuptools, hatchling, poetry or PDM. For hand-rolled layout see rseng-code-quality; for the management side see rseng-project-kickoff.

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills星标 24(GitHub 24 + cccskills 0)

实测评分 未实测

查看安装方法

包含的文件(2)

  • SKILL.md5.3 KB
  • references.md401 B

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Project scaffolding from templates

Starting from a maintained community template gives a research software project the whole quality baseline - packaging, tests, CI, linting, citation files, docs - in one step, encoded the way its community actually practices it. The skill here is threefold: pick the right generator, generate (or retrofit) honestly, and keep the project in sync as the template evolves.

Choosing a generator

  • Copier: templates are versioned; copier update can replay template improvements into an already-generated project later. Prefer it when the template supports it - staying current is the hard part of template use, and Copier is built for it.
  • cookiecutter: widest ecosystem of templates; generation is one-shot (no built-in update path), so treat the result as a starting point you own from day one.

Prefer a template maintained by a research software community over a generic one: it will encode citation files, FAIR practices and research-specific CI that generic templates omit.

The NLeSC python-template (reference implementation)

The Netherlands eScience Center's Copier template (https://github.com/NLeSC/python-template, Apache-2.0, actively maintained) is a strong default for research Python packages:

pipx install copier
copier copy https://github.com/nlesc/python-template.git path/to/project
copier update                    # later: pull template improvements
  • Three profiles: Minimum (essentials), Recommended (curated defaults), or fully custom - match the profile to the software tier (analysis code -> Minimum; shared tools -> Recommended).
  • It can also retrofit structure onto EXISTING code: run copier copy into the existing directory and reconcile.
  • What it encodes (Recommended): src/ layout, setuptools + setuptools-scm build backend, pytest with branch coverage, tox matrix following the SPEC 0 version policy (three most recent Python minors), ruff as single linter/formatter/import-sorter, type checking (Pyright default, Mypy optional), pre-commit, EditorConfig, CITATION.cff plus a cffconvert CI check, Zenodo DOI instructions, Sphinx docs with Read the Docs, SonarCloud analysis, changelog, community files, and a next_steps.yml workflow that opens onboarding issues for the manual setup steps (Zenodo, SonarCloud, Read the Docs).
  • Expect opinionated defaults (line length 79, SonarCloud rather than other coverage services); accept them unless the project has a reason not to - fighting a template forfeits copier update.

Choosing a build backend

When scaffolding by hand or answering template questions:

  • setuptools + setuptools-scm: the template's default; version derived from git tags; battle-tested.
  • hatchling: modern, minimal configuration; good default for new hand-rolled packages.
  • poetry / PDM: bring their own dependency workflow; choose them only when the team wants that workflow, not just a build backend.

Whatever the choice, keep all tool configuration in pyproject.toml sections rather than scattered dotfiles where the tools support it.

After scaffolding

Generation is the start, not the finish:

  • Work through the template's onboarding steps (the NLeSC template opens them as GitHub issues) instead of leaving badges broken.
  • Delete generated options the project will not use rather than letting them rot; record the answers file (.copier-answers.yml) in git so copier update works.
  • Route the per-practice follow-ups to the sibling skills: tests (rseng-testing), CI (rseng-ci-cd), docs (rseng-documentation), citation (rseng-citation-metadata), releases (rseng-publishing-releasing), FAIR posture (rseng-fair-software, rseng-fairguard).

Working with this skill

This skill is source-independent: its authority is the template and generator documentation linked below, not a bundled content source.

Learn more (verified):

<!-- related-skills:begin -->

Related skills

Check whether any of these applies before moving on:

  • rseng-ci-cd - generated workflow files need understanding
  • rseng-citation-metadata - template ships CITATION.cff and cffconvert check
  • rseng-dependency-management - keeping generated tooling current
  • rseng-fair-software - templates encode the FAIR baseline
  • rseng-project-kickoff - management-side project start
  • rseng-publishing-releasing - packaging and release setup follow-up
<!-- related-skills:end -->

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Covers operating AI coding agents securely: auditing whether the agent runs sandboxed, permission and dangerous-command configuration, containerized environments, secrets kept out of context, network egress and token privileges, prompt-injection risk, and the privacy of agent use itself. Use PROACTIVELY when permission gating is broadly disabled (skip-permissions modes), when secrets are visible to the agent's shell, or when the agent processes untrusted code, issues or web content; when a project holds personal or confidential data while a cloud agent is active (what leaves the machine, retention, training use), or when the user asks how to run coding agents safely or privately. (Supply-chain security: rseng-security; disclosing agent contributions: rseng-ai-declaration.)

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills242026年9月23日 更新

Covers declaring AI involvement with the AI Declaration Format (https://ai-declaration.org): creating and maintaining an aidecl.yaml that records which AI tools and agents were used, what each contributed, when and how much, plus the README disclosure footnote, JSON/JSON-LD export and CI validation. Machine-readable disclosure is the practice; this format is one implementation. Use PROACTIVELY when an AI assistant or agent creates or modifies a project's content - generate aidecl.yaml if missing, update it after AI-assisted changes. Also use when the user asks about AI transparency, provenance, disclosure or EU AI Act disclosure, wants to state that NO AI was used, or mentions aidecl. For concealment requests see rseng-honesty; for the human review duty see rseng-human-verification.

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills242026年9月23日 更新

Covers long-term archiving of research software and data: Software Heritage save requests and SWHID persistent identifiers, Zenodo deposits with versioned DOIs and forge integration, choosing domain and institutional repositories, deciding what to archive (code, data, environments, documentation) and when, and archiving at project retirement. Use when the user wants software or data preserved beyond the life of a forge account, grant or lab, mentions Software Heritage, SWHIDs, Zenodo deposits or archiving, retires or hands over a project, prepares artifacts that must stay resolvable for a paper, or when funder policy requires long-term preservation. (Cutting the release itself is rseng-publishing-releasing; day-to-day data storage and repository choice is rseng-data-management.)

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills242026年9月23日 更新

Covers processing research data that outgrows one machine's memory: out-of-core and chunked computation, Dask for scaling the scientific Python stack, Spark for distributed tabular pipelines, lazy evaluation, partitioning strategies, idempotent and restartable batch jobs, and knowing when NOT to distribute. Use when datasets no longer fit in memory, when the user mentions Dask, Spark, out-of-core or larger-than-memory data, when a pandas/NumPy workflow hits memory limits, or when designing batch pipelines over many files. (Cluster job submission and job arrays are rseng-hpc-computing; pipeline orchestration engines are rseng-workflows; profile first with rseng-performance-profiling.)

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills242026年9月23日 更新

Covers continuous integration and delivery for research software: CI/CD concepts, automating builds and tests with GitHub Actions and GitLab CI/CD, and wiring an organization's GitLab CI infrastructure to a GitHub-hosted project. Use when the user asks to set up CI, write a pipeline or workflow file (.github/workflows, .gitlab-ci.yml), add automated builds/tests on push or pull request, publish a package or deploy docs when a tag or release is cut, cache dependencies to speed up CI runs, choose between GitHub Actions and GitLab CI, use self-hosted or GPU runners, mirror a repo, or report external CI status back to GitHub. For what to test and shrinking a test matrix see rseng-testing; for linter and pre-commit policy see rseng-code-quality.

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills242026年9月23日 更新

Covers verifying that every citation is real, correct and current: checking references in manuscripts, READMEs, references files and code metadata against Crossref and OpenAlex, screening cited DOIs against the Retraction Watch database, catching fabricated or mis-attributed citations (a documented AI failure mode), and keeping bibliographies and CITATION.cff files resolvable. Use PROACTIVELY before any bibliography, reference list or citation metadata is finalized or published, whenever the agent itself has produced citations, and when the user asks to check references, mentions broken DOIs, retracted papers or citation verification, or prepares a manuscript, README or software paper with references. (Making your own software citable is rseng-citation-metadata.)

中文简介正在准备中。当前显示原文说明。

fdiblen/rseng-agent-skills242026年9月23日 更新

查看 fdiblen 的全部技能

报告此技能的问题