Thanks so much for your interest in contributing to TRANSPOSE!
Peer review is foundational to our current system of creating and sharing knowledge, yet almost everything about this process is typically shrouded in secrecy. In order to make the publishing process more open, accessible, and fair, we will work to bring transparency to journal policies and practices, about which little is known on a systemic level. To accomplish this, we'll build a user-editable database of journal policies on the openness of peer review, the recognition of early career researchers who contribute to peer review, and detailed policies on preprinting. To accomplish this, we'll build off of the SHERPA/RoMEO database, which contains information about preprint archiving and also an ontology of journals, publishers, and policy groups.
These guidelines will help you get involved with TRANSPOSE.
- Participation guidelines
- What we're working on
- How to change policy records
- How to report bugs
- Communication channels
This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Check the issue tracker for projects labeled MozSprint!
Specifically, we'd like to begin filling in information relevant to some of the largest or most prominent journals. Check this list of prioritized journals and find one you'd like to work on.
You can change policy entries in just a few minutes in your browser!
- Fork the repo. Press the "Fork" button at the top right of the screen to fork this repository to your own account. (You only need to do this once)
- Identify a policy you want to edit. In transpose-publishing/policies-database, search for your journal name of choice in the search bar at the top of the screen. If the journal appears in a policy record, you will see a file like "/policies/romeo_4.yml" show up in the search results. Copy this file path.
- Find the policy in your own fork. In your own fork of the repository, press "find file" (next to the green "Clone or Download" button). Now paste the file path from the previous step here.
- Edit the record. Once you're looking at a policy record, click the pencil icon to edit it. Fill in as much information as you would like by referencing the journal website. Please also add references for the information you're adding in the corresponding url fields. Many journals won't have explicit policies on the web, so don't worry about filling out everything! Tips for editing: If you're pasting long text in, keep everything on the same line. Leave one space betwen the colon in the data field and your response, like so:
open-reports: yes- Commit changes. Press the green "Commit changes" button at the bottom of the page to save your edits to your own copy of the repository. At this point, you can repeat steps 2-6 if you want to change more policies!
- Submit a pull request. To propose merging your changes back into the master copy, navigate back to transpose-publishing/policies-database. Click the "New pull request" button. On the next screen, click the text link that says "Compare across forks" and change the "Head fork" drop down to your own copy of the repo. Then click the green "Create pull request" button.
- That's it! We'll leave a comment if we notice any issues or problems that could be revised.
More general information about this process is below:
- Fork this repository. This makes your own version of this project you can edit and use.
- Make your changes! You can do this in the GitHub interface on your own local machine. Once you're happy with your changes...
- Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.
First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub.
Notice a mistake? Please file any bugs, requests, or questions in our issue tracker!
