openjournal-template

User Guide

This guide describes how to manage and review submissions for an Open Journal. We make use of OJ as a placeholder for the name of the journal.

For Authors

Create Submission

To create a new submission:

Go to the GitHub project page of the OJ you want to submit to. The URL will look something like:
```
https://github.com/<ORG>/<OJ>
```
where <ORG> is the name of the organization and <OJ> the Github project name of the journal.
Click on the articles.md file:

then click on the Edit button:

The above will open an editing window where you can modify the articles.md file. In order to add a new submission to the table of accepted articles, add a new entry to the exsiting table. A new entry has the following format:
```
<Title> | <Authors> | <URL> |
```
Where Title is the title of your article, Author is a list of comma-separated names and URL is a link to the article. Note that the | symbols separate each field and its important to include them.
After accomplishing the above, go the bottom of the page, where you will find a form with a Propose change button:

you will see a new page containing a form for creating a pull request (PR) like the following:

Click on the Create Pull Request button to create a new submission. This will open another page where you will finally create a new PR:

To attach files (e.g. a .docx document) to the submission you can drag and drop them to the PR comment box (see here for more).

Respond to Comments from Reviewers

Once you create a submission, the editors of the journal will receive a notification and will assign reviewers to your submission. Once reviewers read your article, they will leave comments on the Pull Request associated to your submission. To respond to their comments, you can use the text form found in this page (see here for more)

For Reviewers

When an editor assigns you as a reviewer to a submission, you will get a notification sent by Github. Opening the associated link will take you to the pull request associated to the submission.

For Editors

Journal Setup

To create a new journal:

Click “Use this template” on the main page of the repository.
From the template cloned in you repository, edit the README.md file to create the main page of your journal.

You are done! Your journal will be hosted at:

`<youraccount>.github.io/<your_journal_id>`.

Assign Reviewers

As submission is handled via a pull request, the editor assign reviewers using github assignments as described here.

Approve Submission

Once the paper is approved, the editor merges the pull request to add the paper to the journal record as described here using the “squash and merge” option.