You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .dev/README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,25 @@
1
1
# data.table developer
2
2
3
+
Inside this repository we provide some tools that improves development experience. Most notable one is `cc()` helper function that recompiles C sources, reload R sources and run tests.
4
+
5
+
Typical development workflow will then look like:
6
+
7
+
0.`git checkout -b [branch]`
8
+
1. edit package files
9
+
2. run `R`
10
+
3. call `cc()`
11
+
4. (if needed) go to point 1.
12
+
13
+
Once we (and tests) are satisfied with changes, we then run complete package checks:
14
+
15
+
0. in shell terminal
16
+
1. run `make build`
17
+
2. run `make check`
18
+
3. (optionally) run `R=~/build/R-devel/bin/R make check`
19
+
4. (optionally) run `R=~/build/R-340/bin/R make check`
20
+
5.`git commit -m '[changes description]'`
21
+
6.`git push [remote] [branch]`
22
+
3
23
## Setup
4
24
5
25
To use the optional helper function `cc()`, one needs to set up the project path and source `.dev/cc.R` to use `cc()` conveniently. This works through creating an additional `.Rprofile` in the `data.table` directory.
0 commit comments