-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from yochannah/poster
Poster
- Loading branch information
Showing
10 changed files
with
50 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,3 +25,6 @@ If you'd like to provide your support before we finalise the consultation period | |
- Twitter: [@codeisscience](https://twitter.com/codeisscience/) | ||
- Email: [email protected] | ||
- GitHub: You can also [create issues on the manifesto repository](https://github.com/codeisscience/manifesto/issues/new?title=[Manifesto%20Comment]) | ||
|
||
|
||
[Tweet this](https://twitter.com/intent/tweet?ref_src=twsrc%5Etfw&related=%40codeisscience&text=I%20adhere%20to%20the%20%22Code%20is%20Science%22%20manifesto%20via%20%40codeisscience%20https%3A%2F%2Fcodeisscience.github.io%2Fmanifesto%2Fmanifesto%2C%20so%20can%20you%20too!&tw_p=tweetbutton&url=file%3A%2F%2F%2Fh%2Fk%2Findex.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,63 @@ | ||
# Code is Science Manifesto | ||
|
||
Through working with scientific code, we agree that scientific code needs to be treated as a genuine research output. | ||
Through working with scientific code, we agree that it needs to be treated as a | ||
primary research output. | ||
|
||
## Preamble | ||
Code is science. Historically, science has been reviewed by its peers to validate it before being published. In modern times, computer code forms part of scientific analysis, but it is rarely shared and reviewed. | ||
|
||
This manifesto is for anyone who deals with code in a scientific setting, including publishers, researchers, research software engineers, and administrators. | ||
Code is science. Historically, science has been reviewed by its peers to | ||
validate it before being published. In modern times, computer code forms part of | ||
scientific analysis, but it is rarely shared or reviewed. | ||
|
||
This manifesto is for anyone who deals with code in a scientific setting, | ||
including publishers, researchers, research software engineers, and | ||
administrators. | ||
|
||
## Manifesto Principles | ||
|
||
### Open over closed | ||
Ideally scientific code should be released by the time of publication, under an open source licence, such that anyone may download, review, re-use and expand upon it. | ||
|
||
### Code for the future | ||
Follow [good practices](https://software.ac.uk/resources/guides/software-development-general-best-practice) from the start of the project; don’t build up [technical debts](https://en.wikipedia.org/wiki/Technical_debt) that are hard to fix later. This generally means testing, writing documentation, instructions on how to run and maintain your code, and following modern development practices. | ||
Ideally scientific code should be released by the time of publication, under an | ||
open source licence, such that anyone may download, review, re-use and expand | ||
upon it. | ||
|
||
### Incorrect code results in incorrect science | ||
Code published in journals should be peer reviewed. Ensure that at least one reviewer understands code well enough to evaluate it critically, as well as domain experts who can comment on the specific scientific area. | ||
|
||
Published code should be peer reviewed. Ensure that at least one reviewer | ||
understands code well enough to evaluate it critically, as well as domain | ||
experts who can comment on the specific scientific area. | ||
|
||
### Code for the future | ||
|
||
Follow [good | ||
practices](https://software.ac.uk/resources/guides/software-development-general-best-practice) | ||
from the start of the project; don’t build up [technical | ||
debts](https://en.wikipedia.org/wiki/Technical_debt) that are hard to fix later. | ||
This generally means automated testing, writing documentation, instructions on | ||
how to run and maintain your code, and following modern development practices. | ||
|
||
### Availability over perfection | ||
You don’t have to be a computer scientist or professional software developer to write code, and your code doesn’t have to be perfect in order to be published. If code produces paper-ready results, the code too is paper-ready. | ||
|
||
There is always room to improve your skills — some intensive training courses such as [Software Carpentry](https://software-carpentry.org/) only take a day or two. | ||
You don’t have to be a computer scientist or professional software developer to | ||
write code, and your code doesn’t have to be perfect in order to be published. | ||
If code produces paper-ready results, the code too is paper-ready. | ||
|
||
There is always room to improve your skills — some intensive training courses | ||
such as [Software Carpentry](https://software-carpentry.org/) only take a day or | ||
two. | ||
|
||
Be nice and provide [constructive criticism](https://www.software.ac.uk/blog/2017-05-11-constructive-code-critique), when reviewing recognise that people make mistakes in good faith. | ||
When reviewing code be nice and provide [constructive | ||
criticism](https://www.software.ac.uk/blog/2017-05-11-constructive-code-critique). | ||
It is important recognise that people make mistakes in good faith. | ||
|
||
### Code deserves credit | ||
Software should be [cited](https://www.force11.org/software-citation-principles)(You don’t have to be a computer scientist or professional software developer to write code, and your code doesn’t have to be perfect in order to be published. If code produces paper-ready results, the code too is paper-ready) and acknowledged as scientific output. This means you should cite your sources as well as ask to be cited yourself. | ||
|
||
Software should be [cited](https://www.force11.org/software-citation-principles) | ||
and acknowledged as scientific output. This means you should cite your sources | ||
as well as ask to be cited yourself. | ||
|
||
## Background | ||
|
||
- [Agile Manifesto](http://agilemanifesto.org/) | ||
- [Data Ops Manifesto](http://dataopsmanifesto.org/) | ||
- [Software Sustainability Institute Collaboration Workshop 2018](https://www.software.ac.uk/cw18/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
We used gravit designer to create this poster, available at | ||
https://www.designer.io/ | ||
|
||
The fonts are Roboto Sans, Slab, and for the url at the bottom of the page, Roboto Mono. |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.