Fixes issues #18 #19 #21 #23 #25
Conversation
pbellec
requested review from
complexbrains,
katjaq,
agahkarakuzu,
ccraddock,
r03ert0 and
SamGuay
There was a problem hiding this comment.
Thank you so much for editing this and making it shorter :D \\ö//
One question:
in contributing lines 246 following: should it read "Brainhack" (like now) or should it read "Brainhack Proceedings" welcomes ... etc?
this paragraph:
## [Recognizing contributions](#recognizing_contributions)
Brainhack {Proceedings} follows the [all-contributors](https://github.com/kentcdodds/all-contributors#emoji-key) specification, so we welcome and recognize all contributions from documentation to testing to code development. You can see a list of current contributors here.
Else than that, lots of changes :D but those that I checked all great! 🚀 Thanks so much!
approved! (unless you want to make above mentioned change and add "Proceedings"
| ## Writing in markdown | ||
| GitHub has a helpful page on [getting started with writing and formatting on GitHub](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github). | ||
| Most of the writing that you'll do will be in [Markdown](https://daringfireball.net/projects/markdown). You can think of Markdown as a few little symbols around your text that will allow GitHub to recognize and format the text. For example, you could write words as bold (`**bold**`)`, or in italics (`*italics*`), or as a link (`[link](https://https://youtu.be/dQw4w9WgXcQ)`) to another webpage. | ||
| Most of the writing that you'll do will be in [Markdown](https://daringfireball.net/projects/markdown). You can think of Markdown as a few little symbols around your text that will allow GitHub to recognize and format the text. For example, you could write words as bold (`**bold**`)`, or in italics (`*italics*`), or as a link (`[link](https://https://youtu.be/dQw4w9WgXcQ)`) to another webpage. |
There was a problem hiding this comment.
The current md format is still a bit LateX-flavored, should we add some instructions re how to add a figure etc.?
There was a problem hiding this comment.
Big disclaimer: I have not changed (or reviewed) CONTRIBUTING.md
I just added it to the index.
In my mind CONTRIBUTING should be for people interested in contributing to the brainhack-proceedings workflow. Instructions for authors should be either in the template, "how to submit", or "paper guidelines".
One notable one is pushing the page limit to 4 pages. With the template we are using, and the suggestion we make for sections, it will be very hard to keep it under two pages. And this is an upper limit, I also added a note that shorter submissions would be welcome. |
| ### Educational resources or event | ||
| - Specify the target community for the educational resource/event. | ||
| - Specify how you assessed the utility of proposed educational resources/event for the target community. | ||
| - Describe the support resources for the proposed educational resources/event (documentation, website) | ||
| - Describe the plan for dissemination of the educational resources/event in the target community. | ||
| - Describe the plan for measuring the engagement and effectiveness of the educational resources/event in the target community. |
There was a problem hiding this comment.
These lines repeat the similar if not the same content from lines 43-48. We should keep on or the other.
| - After all issues have been addressed, a "publish" release will be made by the editor. | ||
| - All versions of the paper will be posted on [https://brainhack-proceedings.github.io](https://brainhack-proceedings.github.io) right after the initial submission. | ||
|
|
||
| - Make sure that you archive your repository in [Zenodo](https://guides.github.com/activities/citable-code/)or [Figshare](https://mozillascience.github.io/code-research-object/) together with your submission to Brainhack Proceedings. Doing so, you will get a Digital Object Identifier (DOI) for your repository while providing a time-free representation to your paper and associated code repositories. |
There was a problem hiding this comment.
| - Make sure that you archive your repository in [Zenodo](https://guides.github.com/activities/citable-code/)or [Figshare](https://mozillascience.github.io/code-research-object/) together with your submission to Brainhack Proceedings. Doing so, you will get a Digital Object Identifier (DOI) for your repository while providing a time-free representation to your paper and associated code repositories. | |
| - Make sure that you [archive your repository](https://guides.github.com/activities/citable-code/) with data archiving tools such as [Zenodo](https://zenodo.org/) or [Figshare](https://figshare.com/) together with your submission to Brainhack Proceedings. Doing so, you will get a Digital Object Identifier (DOI) for your repository while providing a time-free representation to your paper and associated code repositories. GitHub provides a clear step-by-step tutorial on [Making Your Code Citable](https://guides.github.com/activities/citable-code). |
No description provided.