Roadmap #17
Description
Roadmap
Contributorship Badges for Science
Issuing badges to credit authors for their work on academic papers.
Using Mozilla's Badgekit-api to implement our badges, we can issue and fetch badges from badgekit via the badgkit-api-client. By authenticating against ORCID, a user can reliably issue badges to a valid ORCID, the standard unique researcher identifier.
Want to jump in?
- Good first bugs: This is a good place to start if you're new to the project. These issues are all mentored.
- Design: We need some help designing interfaces and deciding how these badges will look on a paper page / on an ORCID page.
- Writing code: Ready to write some JavaScript with us? These issues are waiting for you!
- Discuss: There are still some open ended questions for this prototype. Join in on the discussion.
Short term - what we're working on now 🎉
- Testing (Add tests for API endpoints #75)
- Mocha, supertest. Help us make sure we're building things that work! The testing framework has been added. Tests needed.
- Add tests for API endpoints #75 Add tests for API endpoints
- Mocha, supertest. Help us make sure we're building things that work! The testing framework has been added. Tests needed.
- New JavaScript snippets ( Creating JavaScript snippets #72, Add a loading spinner while widget is loading #142, Use crossref API to fetch paper names #124)
- Any ideas on how we can better visualize these badges? Our API is ready for use! Use the data we have available in our API to write a JS snippet that visualizes a users / a papers badges. Built using our JSON endpoints, implement the visualizations created in Designing Badges #71. By providing these snippets, a journal (or an author, or ORCID) can just embed the snipped on their website to view badges for this paper/author.
- Stability / bug fixes (Widget doesn't return results for DOIs with extra stashes. #135, Add cron job to restart badgekit #129, Error when logging in #132)
- Some smaller tasks we need to make the paper badger widget work better for more users.
- Add redis to the Docker setup (Add redis to Docker setup #155)
- Redis was added after we set the project up with Docker. Add redis and updates the docs!
Medium term - what we're working on next! 🍰
- Migrating away from badgekit-api (Migrate away from BadgeKit-api to Badgr #159)
- Since our launch, we've learned that badgekit-api isn't optimized for our use case. Up next is researching and planning our migration.
- Potential 'Google Summer of Code' Project
- Implement endpoints for publishers (Journal submission system integration #160)
- Right now, publishers need to fill out a web form to issue badges to their papers. Implementing endpoints will make it possible for them to integrate their paper submission system with Paper Badger.
- Potential 'Google Summer of Code' Project
Longer term items - working on this soon! ⏩
These items are not essiential for an MVP, but are a part of our longer term plans. Feel free to jump in on these if you're interested!