Skip to content

Commit 6cf271d

Browse files
authored
Merge pull request #11 from tonic-team/readme_additions
Update README.md
2 parents 9250fa9 + e18a3ea commit 6cf271d

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
# Project title
1+
# FIXME:Project title
22

3-
## Abstract
3+
## Abstract, vision and goals
4+
5+
## Milestones
46

57
## Contributors
68

7-
- jane doe, jane.doe@example.com, https://orcid.org/XXXX-XXXX-XXXX-XXXX
9+
- jane doe, jane.doe@example.com, https://orcid.org/XXXX-XXXX-XXXX-XXXX, role:, responsibilities: , special skills
810

9-
[Please mention your contributors either by including a contributors list here, or by referring to another file that lists your contributors, see documentation for options and examples.]
11+
[Mention your contributors either by including a contributors list here, or by referring to another file that lists your contributors, see documentation for options and examples. It is good practice to set roles for each contributor at the start of the project and discuss author byline of a future paper early.]
1012

1113
## List of experiments
1214

1315
## Direct links (inside or outside this repository)
1416

1517
- todo list: [use issues](../../issues)
1618
- data management plan: [01_project_management/05_data_management_plans](01_project_management/05_data_management_plans)
17-
- Smartfigure tag: [YOURTAG](https://sdash.sourcedata.io/?q=YOURTAG) : replace YOURTAG in the url and the text.
19+
- Smartfigure tag: [YOURTAG](https://sdash.sourcedata.io/?q=YOURTAG) [FIXME:replace YOURTAG in the url and the text.]
20+
- Main Communication channel: FIXME
1821

1922
## Other information
2023

21-
**Note:** This repository follows the Research repository template, v.2.2, see [further information offline](.doc/information.md) or [the online documentation page](https://gin-tonic.netlify.app/).
24+
**Note:** This repository follows the Research repository template, v.2.3, see [further information offline](.doc/information.md) or [the online documentation page](https://gin-tonic.netlify.app/).
25+
26+
## Contribution
27+
28+
If you are new to this project, familiarise yourself with the vision, set your own role and responsibilities with the team, and read the data management plan. Make sure your contributions can be understood and reused by other members of the team.

0 commit comments

Comments
 (0)