https://github.com/faroit/mdx-submissions21
https://github.com/faroit/mdx-submissions21
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/faroit/mdx-submissions21
- Owner: faroit
- Created: 2021-08-10T13:35:43.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-10T13:54:11.000Z (almost 5 years ago)
- Last Synced: 2025-01-28T02:32:49.548Z (over 1 year ago)
- Language: TeX
- Size: 13.7 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MDX Workshop Submissions
This is the submission repository for the [Music Demixing Workshop 2021](https://mdx-workshop.github.io). The submission system is based on Github pull requests and is fully transparent and open for both, authors and reviewers.
### How to write an article
All submissions are created via markdown files and uses the same template and syntax as in the [Journal of Open Source Software](https://joss.readthedocs.io/en/latest/submitting.html). An example paper can be seen in [paper.md].
### How to submit an article ?
1. Create a [github](https://github.com) account
2. [Fork](https://help.github.com/articles/fork-a-repo/) the [MDX workshop submission](https://github.com/mdx-workshop/mdx-submissions21) repository
3. Clone this new repository into your desktop environment
```
$ git clone https://github.com/YOUR-USERNAME/mdx-submissions21
```
4. Create a branch (the branch name should be author names separated with dashes)
```
$ git checkout -b AUTHOR1-AUTHOR2
```
5. Add your article and commit your changes:
```
$ git commit -a -m "Some comment"
```
6. [Push](https://help.github.com/articles/pushing-to-a-remote/) to github
```
$ git push origin AUTHOR1-AUTHOR2
```
7. Issue a [pull request](https://help.github.com/articles/using-pull-requests/) (PR) with title containing author(s) name and follow the template that will appear once you opened the pull request.
9. Answer questions and requests by the reviewers made in the PR conversation page.
10. The pull request will be closed when the paper is accepted and published.
### How to preview and article
All markdown papers are automatically compiled to PDF using a github action service. This can be used to preview the PDF before submission. Look for the `paper` artifacts of the `Paper Draft`.