matplotlib / matplotlib/ipympl

add citation information

Open
#160 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
1.7k
Forks
234
PR merge metrics
No merged PRs in 30d

Description

I'd like to cite jupyter-matplotlib in something I'm working on. What is the preferred citation information for this repository? If I use Zotero to scrape the metadata this is what I get:

@misc{jupyter-matplotlib_2019,
	title = {jupyter-matplotlib},
	copyright = {BSD-3-Clause},
	url = {https://github.com/matplotlib/jupyter-matplotlib},
	abstract = {Matplotlib Jupyter Extension. Contribute to matplotlib/jupyter-matplotlib development by creating an account on GitHub.},
	urldate = {2019-11-19},
	publisher = {{Matplotlib Developers}},
	month = nov,
	year = {2019},
	note = {original-date: 2016-07-21T14:38:56Z},
} 

however, I'm not sure of how authorship should be determined? I could list all 13 contributors of this repository, or it could be "Matplotlib Developers", or something else? What would be best here?

I'm happy to contribute this information back into the repo in the readme or a citation file if you'd like too.

Contributor guide

Open the contributing guide

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 checking the repository README and any existing citation metadata. Determine the preferred authorship and citation format from the repository information, then document it in the README or a citation file so users can cite ipympl consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.