https://github.com/ColinFay/r-devel-doc
Documenting the process of submitting a bug fix to R
https://github.com/ColinFay/r-devel-doc
Last synced: 4 months ago
JSON representation
Documenting the process of submitting a bug fix to R
- Host: GitHub
- URL: https://github.com/ColinFay/r-devel-doc
- Owner: ColinFay
- Created: 2022-06-09T20:01:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-12T13:11:33.000Z (over 2 years ago)
- Last Synced: 2024-08-13T07:15:54.482Z (8 months ago)
- Language: Shell
- Size: 427 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - ColinFay/r-devel-doc - Documenting the process of submitting a bug fix to R (Shell)
README
# r-devel-doc
[WORK IN PROGRESS]
> Note: this process is built on top of personal knowledge and scripts gathered from :
>
> - https://bookdown.org/lionel/contributing/
> - https://github.com/r-devel/r-svn/blob/master/.github/workflows/build-svn.yaml
Documenting the process of submitting a bug fix to R
1. Fork https://github.com/r-devel/r-svn to your GitHub Account
2. Clone the current repo
I suggest you rebuild the container every time so you have a latest version of system requirements
```
# Build the docker image
docker build -t rsourcebuilder --no-cache .
# Launch the image and let it hang, so that we can enter it via VSCode
docker run -d rsourcebuilder tail -f &> /dev/null
# Wait some time for the container to launch
sleep 30
```
3. Go in the container using VSCode docker feature
4. Once inside the container, run the following command, replacing the github url with yours
```
bash /rsourcetools/tools.sh https://github.com/ColinFay/r-svn
```
This will clone the repo & add some tools to the build folder
5. Open folder : /r-svn
6. Do your changes
7. Run the build
```
cd build
bash ./build.sh # (Note that the build can take some time)
```
The script will also run the tests.