Code Monkey home page Code Monkey logo

software-citation's Introduction

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

software-citation's People

Contributors

dependabot[bot] avatar sarthak-sehgal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

software-citation's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.