Skip to content

Commit 4682f53

Browse files
committed
[DOC] add contributing
1 parent bd2b512 commit 4682f53

File tree

2 files changed

+77
-61
lines changed

2 files changed

+77
-61
lines changed

CONTRIBUTING.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing to the BIDS website
2+
3+
**Welcome to the BIDS website repository!**
4+
5+
_We're so excited you're here and want to contribute._
6+
7+
We hope that these guidelines are designed to make it as easy as possible to get involved.
8+
If you have any questions that aren't discussed below, please let us know
9+
by [opening an issue](https://github.com/bids-standard/bids-website/issues/new).
10+
11+
If you are not familiar with Git ansd GitHub,
12+
check our [generic contributing guidelines](https://bids-website.readthedocs.io/en/latest/collaboration/bids_github/CONTRIBUTING.html).
13+
14+
If you want to contribute to the BIDS website,
15+
make sure you also read the instructions below.
16+
17+
## Serving locally
18+
19+
### Requirements
20+
21+
- python >= 3.10
22+
23+
Even though this is not required, having `make` installed
24+
will make it easier to easily serve the website locally.
25+
26+
### Install and serve
27+
28+
Fork and clone the repository and its submodules
29+
30+
```bash
31+
git clone https://github.com/YOUR_USER_NAME/bids-website.git --recurse-submodules
32+
```
33+
34+
Create a virtual environment using `conda`, `venv` of what other environment management tool you prefer.
35+
36+
Install all the dependencies.
37+
38+
```bash
39+
pip install -r requirements.txt
40+
```
41+
42+
Generate all the content required for the build.
43+
44+
```bash
45+
make update
46+
```
47+
48+
Serve the website with the mkdocs.
49+
50+
```bash
51+
mkdocs serve
52+
```
53+
54+
## Maintenance
55+
56+
### Requirements
57+
58+
Same as for the install but you will also need to install `tox`.
59+
60+
```bash
61+
pip install tox
62+
```
63+
<!-- TODO find minimal version of node and npm -->
64+
For some quality checks and rare operations, you will need node.js and npm.
65+
66+
## Update all files
67+
68+
```bash
69+
make update
70+
```
71+
72+
## Run all formatting / linting tools
73+
74+
```bash
75+
tox
76+
make remark
77+
```

README.md

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -3,64 +3,3 @@
33
# The one true BIDS website
44

55
View it here: https://bids-website.readthedocs.io/en/latest/?badge=latest
6-
7-
## Serving locally
8-
9-
### Requirements
10-
11-
<!-- TODO determines minimum python version -->
12-
- python 3.X
13-
14-
## Install
15-
16-
Clone the repo and its submodules
17-
18-
```bash
19-
git clone https://github.com/bids-standard/bids-website.git --recurse-submodules
20-
```
21-
22-
Create a virtual environment using `conda`, `venv` of what other environment management tool you prefer.
23-
24-
Install all the dependencies.
25-
26-
```bash
27-
pip install -r requirements.txt
28-
```
29-
30-
Generate all the content require for the build.
31-
32-
```bash
33-
make update
34-
```
35-
36-
Serve the website with the mkdocs.
37-
```bash
38-
mkdocs serve
39-
```
40-
41-
## Maintenance
42-
43-
### Requirements
44-
45-
Same automation will work better if you are on unix system and have make.
46-
47-
Same as for the install but you will also need to install `tox`.
48-
49-
```bash
50-
pip install tox
51-
```
52-
<!-- TODO find minimal version of node and npm -->
53-
For some quality checks and rare operations, you will need node.js and npm.
54-
55-
## Update all files
56-
57-
```bash
58-
make update
59-
```
60-
61-
## Run all formatting / linting tools
62-
63-
```bash
64-
tox
65-
make remark
66-
```

0 commit comments

Comments
 (0)