Skip to content

Commit bf813d6

Browse files
Merge pull request #4 from alex-konovalov/master
Moving manifesto from index to a separate file
2 parents 8163299 + 4668493 commit bf813d6

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

Diff for: manifesto.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Code is Science Manifesto
2+
3+
Through working with scientific code, we agree that scientific code needs to be treated as a genuine research output.
4+
5+
## Preamble
6+
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.
7+
8+
This manifesto is for anyone who deals with code in a scientific setting, including publishers, researchers, engineers, and administrators.
9+
10+
## Manifesto Principles
11+
12+
### Open over closed
13+
Ideally scientific code should be released by the time of publication, under an open source licence, such that anyone may download, re-use and expand upon it.
14+
### Code for the future
15+
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 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.
16+
### Incorrect code results in incorrect science
17+
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.
18+
### Availability over perfection
19+
You don’t have to be a computer scientist to write code, and your code doesn’t have to be perfect. 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.
20+
Be nice and provide constructive criticism, when reviewing recognise that people make mistakes in good faith.
21+
### Code deserves credit
22+
Software should be cited and acknowledged as scientific output. This means you should cite your sources as well as ask to be cited yourself.
23+
24+
## Background
25+
- [Agile Manifesto](http://agilemanifesto.org/)
26+
- [Data Ops Manifesto](http://dataopsmanifesto.org/)
27+
- [Software Sustainability Institute Collaboration Workshop 2018](https://www.software.ac.uk/cw18/)

0 commit comments

Comments
 (0)