Skip to content

Commit

Permalink
Merge pull request #419 from openjournals/danielskatz-patch-2
Browse files Browse the repository at this point in the history
text smoothing and more detail about paper and references
  • Loading branch information
arfon committed Jul 1, 2018
2 parents b60bb44 + fcef311 commit e7c45f3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/submitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In addition, your paper should include:
- A list of key references including a link to the software archive
- Mentions (if applicable) of any ongoing research projects using the software or recent scholarly publications enabled by it

As this short list shows, JOSS papers are only permitted to contain a limited set of metadata (see header below), Statement of Need, Summary, and Reference sections. You can see an example accepted paper [here](https://raw.githubusercontent.com/adrn/gala/f6bb2532afeed3c0b0feea3037bf71a3f42b2a12/paper/paper.md). Given this paper format it is not permitted to write a "full length" paper i.e. one that includes software documentation such as API (Application Programming Interface) functionality, as this should instead be outlined in the software documentation.
As this short list shows, JOSS papers are only permitted to contain a limited set of metadata (see header below), Statement of Need, Summary, and Reference sections. You can see an example accepted paper [here](https://raw.githubusercontent.com/adrn/gala/f6bb2532afeed3c0b0feea3037bf71a3f42b2a12/paper/paper.md). Given this paper format, a "full length" paper is not permitted, e.g., software documentation such as API (Application Programming Interface) functionality should not be in the paper and instead should be outlined in the software documentation.

## Example paper and bibliography

Expand Down Expand Up @@ -170,6 +170,9 @@ Example `paper.bib` file:
}
```

Note that the paper ends with a References heading, and the references are built automatically from the content in the .bib file when they are mentioned in the paper body.


## Submitting your paper

Submission then is as simple as:
Expand Down

0 comments on commit e7c45f3

Please sign in to comment.