In this document you can find lots of information about this project. You can just scroll down or use the quick links below for each section.
There is no one size fits all system for capturing all of the contributions during different research projects. This could be a scientific research project, a software development project or an open-source community project.
We think it is important that all contributions are recorded and therefore everyone is given credit for their work more fairly.
Current systems that attribute contributions to authors in academic outputs do not include all of the jobs/roles/tasks that are encompassed in research projects.
The current problems include:
- Capturing all roles on a project.
- Capturing all tasks within those roles.
- How to convert this into the actual authorship or contributions list that can be used for project outputs.
- How this list can be presented.
Taking inspiration from Malin Sandstroms Lightning talk at the Software Sustainability Institutes Collaboration Workshop 2021, in which she proposed to combine the current contributions approaches.
Slide from Malin Sandstrom's SSI talk
In this project, we propose to:
- Expand current lists to be more inclusive - using current systems such as CRediT, INRIA, BIDS Contributors.
- Develop a tool to be used to record these contributions during the project such as within a Github repository. This tool builds on the established All Contributor specification for recording contributions but adds a few extras that we consider especially valueable in a scientific context:
- Renderings of your contributors list are embeddable into a wide range of documents, not only on the web, but also in e.g. publications
- Custom templates can be provided
- Pre-generated list of contribution types/contributor roles from a the scientific world
- Python-based command line interface tool
- Develop a way that this can be shown on academic papers - lists, table, cinema title page? (look at e.g. Brainhack paper w 100+ authors and Living with machines).
You can install the command line tool using pip:
python -m pip install git+git://github.com/dokempf/credit-all.git
In alphabetical order:
- Daisy Perry (Writing a code of conduct, Curating data)
- Dominic Kempf (Initial ideas of the project, Writing new code, Writing documentation about the code)
- Emma Karoune (Initial ideas of the project, Curating data)
- Malin Sandström (Initial ideas of the project, Curating data)
- Please review our list of tasks and tell us if something needs to be added.
- Spot a bug and tell us about it!
- Suggest new ways that our contributions list can be presented.
If you have any feedback on the work that is going on, then please get in contact.
If you think you can help in any way or just want to suggest something currently not in the project, then please check out the contributor’s guidelines.
Please note that it’s very important to maintain a positive and supportive environment for everyone who wants to participate. When you join as a collaborator, you must follow the code of conduct in all interactions both on and offline.
Please feel free to get in touch with our team:
Thanks for taking the time to read this project page and do please get involved.