using-this-repo.md 3.86 KB
Newer Older
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
1
---
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
2
layout: default
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
title: Using this repository
parent: Home
has_children: false
nav_order: 2
---

# Using this repository
{: .fs-9 }

How to use and contribute to the community developed resources in this repository
{: .fs-6 .fw-300 }

---

This repository exists to facilitate rapid, user-centred dissemination of information to members of the Open WIN Community and those looking to employ open research practices at WIN.

**Use the sidebar to find essential information on how to cite and contribute to the repository, along with our thanks to those who have helped to develop it.**

# Why are we using Git for creating resources?

23
This repository and the resources contained within it are built using a [version controlled git repository](https://git.fmrib.ox.ac.uk/open-science/community/Open-WIN-Community), rendered into an accessible "book" format.
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

Using git makes it easy to review and accept contributions from many different people, and flexibly update our resources with a full history of activity.

Working this way also provides an accessible starting point for researchers who are unfamiliar with git to practice contributing to a repository and gain confidence using the git process. Using git is essential in open and reproducible research and an excellent skill to have on your CV.

We are pleased to offer all our contributors training and support in git throughout their engagement with the project.

![xkcd-git](https://imgs.xkcd.com/comics/git.png)

Don't worry, no one really knows how to use git.<sup>1</sup> [https://xkcd.com/1597/](https://xkcd.com/1597/)

<sup>1</sup> Of course some people have had a lot of opportunity and need for practice and really do know how to use git. The point is for many of us and our applications, 'simple' git is sufficient and already a big step.

# Providing feedback on this site

This site is for you, so we need to make sure we've got things right!

Providing feedback about this site is a contribution to  the community. Thank you in advance for your contribution! 😃 Any contribution you make will be recorded via GitHub, and we'll make sure you are recognised for it.

## What is an "issue"
An "issue" is a term used by GitHub for a place to track ideas, enhancements, tasks, or bugs.

46
You can leave feedback on this site by commenting on the [issues in our GitHub repository](https://git.fmrib.ox.ac.uk/open-science/community/Open-WIN-Community/-/issues).  You are welcome to comment on any issue that feels relevant. If you are new to the community you might like to first have a go with the issues labelled "good first issue".
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
47

48
49
## Creating a GitLab account to comment
To comment on the issues you will need a WIN GitLab login. If you haven’t got a WIN GitLab account, take a look at [this guide](../gitlab/2-1-starting-gitlab-account) for how to create one.
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
50
51
52
53

## Do I have to write something?
No. If you don't feel like writing out something, you are very welcome to add a quick emoji to something someone else has written. Feedback on other people's feedback is also really helpful!

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
54
![github-issue-emoji](../../img/img-github-issue-emoji.png)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
55
56
57
58
59
60

If you are able to write something, you are welcome to add just a few words, sentences, or paragraphs if you'd like. Whatever works for you is great.

## Will my comments be public?
Yes. We'd really like for all feedback to be public. This will ensure that everything is transparent and well recorded. The aim is to show that community members have had input on these pages, and we’ve listened to and incorporated your feedback.

61
Please don’t be worried about being critical (if something’s not right, I need to know about it!), but please try to be respectful and courteous, as per the [community participation guidelines](../community/CODE_OF_CONDUCT).
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
62
63
64

## Do I *really* have to use GitHub?
If this process really doesn't work for you, I'd still love to receive your feedback one way or another. By email is just fine 😊.