Skip to content

Commit 0e0d7c1

Browse files
authored
Update documentation (#112)
1 parent 9ab8ffe commit 0e0d7c1

23 files changed

+156
-4
lines changed

.Rbuildignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ README.*
1414
coverage.*
1515
^\.pre-commit-config\.yaml$
1616
^codemeta\.json$
17-
init.sh
17+
init.sh
18+
workflows.md
19+
images

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,15 @@ You could initialize this repository in one of two ways:
6666

6767
All CI/CD jobs are defined in the [.github/workflows](./.github/workflows) directory in the form of GitHub Action workflows. These can be modified per your requirements, but are designed and implemented to follow best practices and to ensure the highest quality standards for your package.
6868

69-
All workflows originating from this repository can be repurposed by other R package Github repositories.
69+
All workflows originating from this repository can be repurposed by other R package GitHub repositories.
70+
71+
For more information including detailed description and screenshots of workflows, please refer to [Workflows](./workflows.md).
7072

7173
### Pre-commit
7274

7375
This repository contains an example [pre-commit] configuration.
7476

75-
[pre-commit] is a tool that uses [Git hooks] to identify and resolve simple issues prior to submission for code review.
77+
[pre-commit] is a tool that uses [Git hooks] to identify and resolve simple issues before submission for code review.
7678
[Git hooks] run on every commit to automatically point out and solve issues such as missing semicolons, trailing whitespaces,
7779
code formatting and spell checks.
7880

images/audit.png

77.7 KB
Loading

images/bioccheck.png

22.5 KB
Loading

images/gitleaks.png

21.7 KB
Loading

images/grammar1.png

36.4 KB
Loading

images/grammar2.png

46.8 KB
Loading

images/license-report.png

65.1 KB
Loading

images/links.png

41.8 KB
Loading

images/pkgdown.png

47.8 KB
Loading

0 commit comments

Comments
 (0)