search

get-alex / alex

Catch insensitive, inconsiderate writing
https://alexjs.com
MIT License
4.81k stars 207 forks source link

Best way to reference in a journal article #326

Open aburrell opened 2 years ago

aburrell commented 2 years ago

I want to reference the alex tool in a journal article. Would you consider adding a DOI to this project through something like zenodo? It will make the project easier to track and reference consistently.

Alternatively, is there a preferred reference form? Perhaps it could be added to the FAQ so that others can also find this information without needing to restructure the webpage or README.

wooorm commented 2 years ago

Would you be happy with a citation.cff file? https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

I.e.,

cff-version: 1.2.0
title: alex
message: If you use this software, please cite it as below.
date-released: 2017-12-18
url: https://github.com/get-alex/alex
authors:
- given-names: Titus
  family-names: Wormer
aburrell commented 2 years ago

Yes, especially if it includes a BibTex entry. Poking around the site, this is what I had gathered yesterday, putting it here in case it's helpful.

@misc{alex,
  author = {Wormer, Titus and Sorhus, Sindre and Stransky, Carolyn and Shinn, N. and Weber, Jen and Martine, Riley and Jacobsen, Kieran and Hanlonii, Ricky and Hensel, Kyle and Oliff, Christian and Lahmann, Tobias and Dalton, John-David and Malhotra, Sachin and Mulvey, Lee and Haya, B. and Janardhan, Vaishnavi and Gleason, Alex and Pugh, Brandon and van der Zwaag, Daan and Gautam, Abhinav and Reece, Taylor and Knott, Simon and Wallace, Niklas and Manson, Chris and Mishkin, Yohan and Stewart, Mitchell and Radford, Nick and McGrath, Mary and Junya, Ben and Halliburton, Ansel and Erbridge, F.},
  title = {alex},
  howpublished = {\url{https://alexjs.com/}},
  note = {Accessed: 2021-11-04},
  year = {2017},
  month = {December},
  day = {18},
}