Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publication Listings & Preprint Links #28

Open
nelsonni opened this issue Aug 25, 2020 · 10 comments
Open

Publication Listings & Preprint Links #28

nelsonni opened this issue Aug 25, 2020 · 10 comments
Assignees
Labels
enhancement New feature or request

Comments

@nelsonni
Copy link
Member

nelsonni commented Aug 25, 2020

The Publications page is expected to host links to the official publication, but non-institution affiliated visitors are often barred from accessing these publications due to publishers' paywall-restrictions. However, preprint versions of the publications can be hosted under most academic publishers' preprint policies.

Our current publication listings appear in the following format:

In order to accommodate preprint links (as well as providing additional reference information and awards indicators) we will switch to the following format for all publications (therefore, this format supersedes the format described in #16):

{{Venue Acronym}}  {{Publication Title}}
                   {{Author(s)}}
                   {{Venue Name}} ({{Venue Acronym}}), {{Publisher}}, {{Year}}.
                   {{Awards}}
                   {{DOI}} · {{PDF}} · {{Slides}} · {{Video}} · {{Poster}} · {{Tool}} · {{Data}}

As an example, the "A Tale from the Trenches: Cognitive Biases and Software Development" publication would appear as:

ICSE 2020    A Tale from the Trenches: Cognitive Biases and Software Development
         Souti Chattopadhyay, Nicholas Nelson, Audrey Au, Natalia Morales, Christopher Sanchez,
         Rahul Pandita, and Anita Sarma
         International Conference on Software Engineering (ICSE), ACM, 2020.
         🏆 ACM SIGSOFT Distinguished Paper Award
         DOI · PDF · Video · Data

Any field not available for a given publication should not be displayed (except for DOI, which should always be included and converted to a link when the DOI becomes available for a publication). Remember that authors names should conform to Chicago Citation Style, in the format of {{First Name}} {{Last Name}}, and that author links should be to the People page for current EPICLab members.

@nelsonni nelsonni added the enhancement New feature or request label Aug 25, 2020
@nelsonni
Copy link
Member Author

This update is a change from the previous standard of creating publication-specific sites (e.g. https://epiclab.github.io/ICSE20-CogBias/) for individual publications to gather datasets and related links. Going forward, we will include these types of links and files directly on the Publications page using the bottom-row links described above.

However, in the case of the "A Tale from the Trenches: Cognitive Biases and Software Development" publication there is a URL reference to https://epiclab.github.io/ICSE20-CogBias/ within the publication itself:

Therefore, we will preserve this URL and make it available through the Data link on the publication listing.

@nelsonni
Copy link
Member Author

All preprints should be stored as PDF files in the publications/ directory and named according to the following format:

{{Venue Acronym}}{{Publication Year (2-digit format)}}-{{Last Name of First Author}}.pdf

As an example, the "A Tale from the Trenches: Cognitive Biases and Software Development" publication is stored as:

icse20-chattopadhyay.pdf

@audreyau
Copy link
Collaborator

For journals (e.g. IEEE Transactions on Software Engineering), what should be put under {{Venue Acronym}}? The journal names are too long to fit in that space.

Screen Shot 2020-08-25 at 11 40 23 AM

@nelsonni
Copy link
Member Author

There are acronyms for the journals as well. Here is a short primer:

Journal Acronym
Empirical Software Engineering EMSE
IEEE Transactions on Software Engineering TSE
ACM Transactions on Software Engineering and Methodology TOSEM
Information and Software Technology IST
Journal of Systems and Software JSS
International Journal of Software Engineering and Knowledge Engineering IJSEKE
Journal of Computer Supported Cooperative Work CSCW
Journal of Internet Services and Applications JISA
ACM Transactions on Computer-Human Interactions TOCHI
Journal on Information and Software Technology JIST
IEEE Computer (no acronym) IEEE Computer

Journals typically publish on a semi-annual (or quarterly) basis, so listing Empirical Software Engineering 2020 or EMSE 2020 would not be appropriate in this case. Instead, journal publications should be listed by the journal acronym (i.e. EMSE).

@audreyau
Copy link
Collaborator

When uploading the PDFs for the publications, is there a certain place I should look to find the specific pre-prints or can I just use the PDFs on Anita's website? Also, where do I locate the slides, tools, and data for each paper?

@nelsonni
Copy link
Member Author

Yes, any preprints available on Anita's website can be uploaded and linked from the publications/ directory. Also, all of the publications that I've authored in some capacity are available as preprints on my website: https://nomatic.dev/. There are also slides, tools, and data links on my website that can be directly translated to the EPICLab.github.io site.

Typically, the first authors on papers will likely have most of these artifacts (or at least know where they're currently located). This means that papers involving past EPICLab members will definitely be more difficult to track down, and I would suggest asking Anita if she has any of those artifacts. Otherwise, those publications that cannot be located should just be listed without the links.

@audreyau
Copy link
Collaborator

For the papers that had presentations (e.g.ICSE 2020: A Tale From The Trenches), should we link videos too?

@nelsonni
Copy link
Member Author

Good idea! Let's put those in as a link called Video (preferably next to the Slides link). I'm updating the issue description at the top to include this new link in the format as well.

@audreyau
Copy link
Collaborator

The publication Recommending Tasks to Newcomers in OSS Projects: How Do Mentors Handle It? has two data sites. One is from figshare (this has the interview script) and the other is a zenodo record (this has the codebook). Should I include both links and have two data links?

@nelsonni
Copy link
Member Author

nelsonni commented Aug 26, 2020

The preferred response would be that all data for a publication should be contained in Zenodo or figshare, but not both.

However, since both sites are providing permanent DOI links for inclusion within the publication themselves, let's create a sub-page that contains both links (and a brief explanation for what each link provides). This can be similar to the https://epiclab.github.io/ICSE20-CogBias/ page created for the "A Tale from the Trenches: Cognitive Biases and Software Development" publication, but contained within the https://github.com/EPICLab/EPICLab.github.io repository instead of having separate repositories for sub-pages.

This also leads me to needing to migrate those two publication-specific pages into this repository (and redirecting the URLs to act appropriately based on that new structure).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants