pepkit / pepkit/pepspec

An "Author" section

Open
#13 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10
Forks
4
Avg merge
3h 54m
Merged PRs (30d)
4

Description

One of the review comments is:

Data citation (giving credit) is an important part of open science practice. Do you plan to explicitly support or model these kinds of relations in you configuration files, especially with project modifiers and re-combination of PEPs?

I was wondering if we should add an 'author' block in the pep specification. Or, perhaps this should be an extension and we can write a separate tool that reads and parses such an authorship block?

Thoughts @afrendeiro or @johanneskoester?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the PEP specification and its configuration-file model, then compare an explicit author block with an extension or separate tool. Resolve how authorship, data citation, project modifiers, and PEP recombination should be represented. Done means the chosen approach is agreed and documented in the specification or a defined extension.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.