jupyter / jupyter/jupyter.github.io

Add guidelines for how to cite Jupyter and its subprojects, and which papers are canonical ones for citation

Open
#285 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
HTML
Stars
208
Forks
205
Avg merge
1d 3h
Merged PRs (30d)
10

Description

Jupyter must provide users and readers with guidelines for how to cite Jupyter publications. This will reduce the cognitive load and confusion associated with giving credit to the project (and sub-projects) in scholarly publications.

Jupyter has [authorship guidelines](https://jupyter.org/governance/papers.html) for _writing_ papers, but this doesn't provide guidelines for _citing_ papers. We need to define a lightweight policy for "which paper can make it onto the Jupyter website", as well as implement a place for where they go.

### Next actions

- [ ] Define a policy for deciding whether a paper should be listed on the Jupyter website as a citeable "Jupyter paper"
- [ ] Choose a source-of-truth for where Jupyter's citable papers go
- [ ] Choose a source-of-truth for documenting the guidelines around citations for Jupyter papers
- [ ] Document this in the governance docs, docs.jupyter.org, and jupyter.org
- [ ] Notify all of the subprojects of this policy and encourage them to link to our docs.

### References

- JupyterLab version of this issue: https://github.com/jupyterlab/frontends-team-compass/issues/144

### Known papers in the jupyter ecosystem that might be relevant here

- [Kluyver et al, notebook paper](http://ebooks.iospress.nl/publication/42900)
- [Jupyter et al, Binder 2.0](https://proceedings.scipy.org/articles/Majora-4af1f417-011.pdf)

### Relevant discussions and references for citations in other projects

- [NumPy citations](https://numpy.org/citing-numpy/)
- [SageMath citations](https://wiki.sagemath.org/Publications_using_SageMath)

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 existing authorship guidelines at jupyter.org/governance/papers.html and the citation examples from NumPy and SageMath. Define the paper-listing policy and sources of truth, then document the agreed guidelines in the governance docs, docs.jupyter.org, and jupyter.org and notify the subprojects.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, jekyll
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.