Skip to content
This repository has been archived by the owner on Feb 27, 2022. It is now read-only.

Enabling research software engineers to add citability in open source software without hassle.

License

Notifications You must be signed in to change notification settings

sarthak-sehgal/software-citation

Repository files navigation

Software Citation Project: Beta Out!

"Enabling research software engineers to add citability in open source software without hassle."

Please provide your feedback (anonymous) at https://forms.gle/RCbpupGAnUDRrRM4A

Check out the beta release at http://citation.software or https://software-citation.herokuapp.com/

Website Preview

Software Citation Project is a project aimed at open source software developers who want to enable citability in their software. Open source softwares and packages are widely used and a common problem the developers face is establishing citability to their softwares. Citability is important for researchers for professional as well as personal reasons. It gives them the due credit and recognition. The most common way to enable citation is attaching a DOI through services like Zenodo but you would ideally want to attach a CFF file to your software as well. CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software.

The chicken and egg problem: Zenodo requires you to upload a GitHub release file for your software to which it then attaches a DOI. For this, you have already published a new release for your software without a CITATION.cff! Software Citation Project aims to solve this problem by providing a platform which creates a CITATION.cff file for your software which you can push to GitHub and then publish a release for Zenodo DOI.

This project is a part of eLife Innovation Leaders 2020.

Relevant information

Milestones

  • User journey
  • Wireframes
  • Project Setup
  • Landing page
  • Step 1 UI
  • Zenodo API server integration
  • Step 2 UI (Display sample metadata form with placeholders)
  • Generate .cff and store on server
  • Enable users to add authors in step 2
  • Code of conduct, Contributing Guidelines
  • Create static pages (About, FAQ, Request Feature)
  • Setup server
  • Run cron job to remove CFF files older than 1 hour

About

Enabling research software engineers to add citability in open source software without hassle.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages