Skip to content

Commit c3008ec

Browse files
ns-rsens-rse
committed
chore: MD013 linting line lengths to 80 characters
1 parent 77d7dae commit c3008ec

24 files changed

+554
-272
lines changed

‎.github/ISSUE_TEMPLATE/release-new-version-of-devcontainer.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Checklist for release:
1212
- [ ] Update NEWS file
1313
- [ ] Update CITATION.cff
1414
- [ ] Update VERSION
15-
- [ ] In devcontainer.json, update `"image": "ghcr.io/r-devel/r-dev-env:devel"` to `"image": "ghcr.io/r-devel/r-dev-env:main"`,,
15+
- [ ] In devcontainer.json, update `"image": "ghcr.io/r-devel/r-dev-env:devel"`
16+
to `"image": "ghcr.io/r-devel/r-dev-env:main"`,,
1617
- [ ] Make PR to main branch - needs approving review!
1718
- [ ] Make sure docker container is rebuilt
1819
- [ ] Test container and fix any issues

‎.github/README.md

+41-17
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,63 @@
22

33
![Release](https://img.shields.io/github/v/release/r-devel/r-dev-env)
44

5-
The aim of the R Dev Container is to provide a standard environment for the exploration and development of the R source code. A prototype was developed under Google Summer of Code 2023 and development is continuing under Google Summer of Code 2024.
5+
The aim of the R Dev Container is to provide a standard environment for the
6+
exploration and development of the R source code. A prototype was developed
7+
under Google Summer of Code 2023 and development is continuing under Google
8+
Summer of Code 2024.
69

710
## Getting started
811

912
### Run in a web browser with GitHub Codespace
1013

11-
Click on the button below followed by "Create Codespace" to create and enter your own web based containerised develoment environment.
14+
Click on the button below followed by "Create Codespace" to create and enter
15+
your own web based containerised develoment environment.
1216

13-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=647768262&machine=premiumLinux&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)
17+
[![Open in GitHub
18+
Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=647768262&machine=premiumLinux&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)
1419

15-
The [Starting Codespace section](https://contributor.r-project.org/r-dev-env/container_setup/creating_codespace/) of the R Dev Container Docs will walk you through the process. Then you can work through the tutorials in the docs to lean how to use the codespace for R development.
20+
The [Starting Codespace
21+
section](https://contributor.r-project.org/r-dev-env/container_setup/creating_codespace/)
22+
of the R Dev Container Docs will walk you through the process. Then you can work
23+
through the tutorials in the docs to lean how to use the codespace for R
24+
development.
1625

17-
More details about GitHub codespaces can be found in the [GitHub Codespaces Docs](https://docs.github.com/en/codespaces/overview). GitHub currently offers up to 60 hours for free on dual core codespaces.
26+
More details about GitHub codespaces can be found in the [GitHub Codespaces
27+
Docs](https://docs.github.com/en/codespaces/overview). GitHub currently offers
28+
up to 60 hours for free on dual core codespaces.
1829

1930
### Run on your local computer
2031

21-
The R Dev Container can also be run locally on your computer.
22-
Running the environment requires you to have Docker, VSCode, and the VSCode Dev Containers extension installed.
23-
Upon opening a copy of the [r-dev-env repository](https://github.com/r-devel/r-dev-env) in VSCode you will be prompted to start the dev container.
32+
The R Dev Container can also be run locally on your computer. Running the
33+
environment requires you to have Docker, VSCode, and the VSCode Dev Containers
34+
extension installed. Upon opening a copy of the [r-dev-env
35+
repository](https://github.com/r-devel/r-dev-env) in VSCode you will be prompted
36+
to start the dev container.
2437

25-
The [Local setup section](https://contributor.r-project.org/r-dev-env/tutorials/localsetup/) of the R Dev Container Docs will walk you through the process.
26-
Then you can work through the following the tutorials in the docs to learn how to use the codespace for R development.
38+
The [Local setup
39+
section](https://contributor.r-project.org/r-dev-env/tutorials/localsetup/) of
40+
the R Dev Container Docs will walk you through the process. Then you can work
41+
through the following the tutorials in the docs to learn how to use the
42+
codespace for R development.
2743

28-
More information about Dev Containers can be found in the [Microsoft Documentation](https://code.visualstudio.com/docs/devcontainers/containers).
44+
More information about Dev Containers can be found in the [Microsoft
45+
Documentation](https://code.visualstudio.com/docs/devcontainers/containers).
2946

3047
## Project Background
3148

32-
The standard development process used by members of the R Core Team involves an iterative process of making changes to the source code, re-building R and exploring/testing the changes made.
33-
This process presents a big hurdle for new contributors to R, as setting up their system to build R can be non-trivial, requiring a lot of trouble-shooting, especially on Windows and macOS.
34-
On Linux and macOS, it is not straight-forward to work with different versions of R side-by-side and care needs to be taken not to corrupt or over-write the user's existing version of R/R packages.
35-
36-
For these reasons, we propose to create containerized development environments for R.
37-
Our focus will be on creating a complete environment, including an IDE, that will provide a familiar space for R developers to work on contributions to base R.
49+
The standard development process used by members of the R Core Team involves an
50+
iterative process of making changes to the source code, re-building R and
51+
exploring/testing the changes made. This process presents a big hurdle for new
52+
contributors to R, as setting up their system to build R can be non-trivial,
53+
requiring a lot of trouble-shooting, especially on Windows and macOS. On Linux
54+
and macOS, it is not straight-forward to work with different versions of R
55+
side-by-side and care needs to be taken not to corrupt or over-write the user's
56+
existing version of R/R packages.
57+
58+
For these reasons, we propose to create containerized development environments
59+
for R. Our focus will be on creating a complete environment, including an IDE,
60+
that will provide a familiar space for R developers to work on contributions to
61+
base R.
3862

3963
## Contributors
4064

‎CODE_OF_CONDUCT.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ reporter of any incident.
6464

6565
## Attribution
6666

67-
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
68-
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
69-
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
70-
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
67+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/)
68+
, version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md)
69+
and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md)
70+
, and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

0 commit comments

Comments
 (0)