question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Formalize Citations

See original GitHub issue

Since adding the plagiarism section to the contributing doc, we now have our first set of citations (See Brainfuck). How do we want to formalize these citations? Are the current citations fine?

I was looking into this and dug up the IEEE standard:

<author(s) names> (<date>) <title of program/source code> (<code version>) [<type>]. Web address or publisher.

which might look like the following according to University of Arkansas:

Smith, J (2011) GraphicsDrawer source code (Version 2.0) [Source code]. http://www.graphicsdrawer.com

If we adopt this style, I’d also like to include a link to the snippet by line number(s) at the front of the solution like:

<source link>: <author(s) names> (<date>) <title of program/source code> (<code version>) [<type>]. Web address or publisher.

Alternatively, we can keep the more descriptive citations that we have now. In fact, I think I like those better because we can be clear in how and why we chose to borrow some code. In addition, we can state whether or not the code was copied verbatim, or if the solution was adapted from the cited code.

That said, we should probably agree on some sort of standard citation. Any ideas?

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
chrboecommented, Aug 24, 2018

Just my 2¢ on this, I think more informal citations are fine (though I’m probably biased since I’m the one who started doing it that way in the first place). Formal citations would be nice too, though I think finding out the exact author name every time could get difficult in some cases.

I think it’s probably enough to just include the source (e.g. URL) and a brief note on why the snippet was stolen/repurposed. I think a note like this could be helpful for future editors of the snippet (i.e. removing unused citations and better understanding what existing citations are about).

That said, I do agree about the link rot situation. web.archive.org is probably a fine solution in 99% of all cases, and I’m sure we can think of something else if a site happens to be unavailable on the archive.

1reaction
jrg94commented, Aug 25, 2018

Apparently, web.archive.org allows you to take live snapshots of websites, so you can archive them right as you access them. Unfortunately, I don’t think this will work for web apps like the text generator you used, but I could be wrong.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Formalize Definition & Meaning - Merriam-Webster
The meaning of FORMALIZE is to give a certain or definite form to : shape. How to use formalize in a sentence. ......
Read more >
[1807.05174] First steps towards a formalization of Forcing
We formalize the definition of forcing notions as preorders with top, ... Cite as: arXiv:1807.05174 [cs.LO] ... References & Citations.
Read more >
Formalize reference standard #715 - OWASP/ASVS - GitHub
I had asked: Is there a standard or preferred way of referencing ASVS controls? Ex: combination of ASVS release/milestone version and shortcode?
Read more >
[PDF] Using OCL to formalize object ori-ented metrics definitions
47 Citations. Background Citations. 14. Methods Citations. 17. Results Citations. 1. View All. Figures and Tables; 47 Citations; 85 References ...
Read more >
Formalization of a Newton series representation of polynomials
References · T. W. Alasdair Armstrong, Georg Struth. Programming and Automating Mathematics in the Tarski-Kleene Hierarchy. 2014. · Y. Bertot, G. Gonthier, S....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found