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: CONTRIBUTING.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to quarto-template
1
+
# Contributing to description-file
2
2
3
-
First off, thanks for taking the time to contribute to `quarto-template`!
3
+
First off, thanks for taking the time to contribute to `description-file`!
4
4
5
5
All types of contributions are encouraged and valued. See the
6
6
[Table of contents](#table-of-contents) for different ways to help and details
@@ -24,13 +24,13 @@ maintainers and smooth out the experience for all involved.
24
24
25
25
## Code of conduct
26
26
27
-
This project is released with a [Contributor Code of Conduct](https://github.com/rdatatoolbox/quarto-template/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <rdev.nc@gmail.com>.
27
+
This project is released with a [Contributor Code of Conduct](https://github.com/rdatatoolbox/description-file/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <rdev.nc@gmail.com>.
28
28
29
29
30
30
31
31
## Style guide
32
32
33
-
We use the [Tidyverse style guide](https://style.tidyverse.org/) for writing R code. Functions are documented with the [roxygen2](https://roxygen2.r-lib.org/articles/roxygen2.html) syntax. `quarto-template` uses the `lower_snake_case`.
33
+
We use the [Tidyverse style guide](https://style.tidyverse.org/) for writing R code. Functions are documented with the [roxygen2](https://roxygen2.r-lib.org/articles/roxygen2.html) syntax. `description-file` uses the `lower_snake_case`.
34
34
35
35
36
36
@@ -42,12 +42,12 @@ If you want to contribute by commiting changes, please try to use the [Conventio
42
42
43
43
## Asking questions
44
44
45
-
Before you ask a question, it is best to search for existing [Issues](https://github.com/rdatatoolbox/quarto-template/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
45
+
Before you ask a question, it is best to search for existing [Issues](https://github.com/rdatatoolbox/description-file/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
46
46
47
47
If you then still feel the need to ask a question and need clarification, we recommend the following:
48
48
49
-
- Open a new [Issue](https://github.com/rdatatoolbox/quarto-template/issues/new).
50
-
- Use the template [other_issue.md](https://github.com/rdatatoolbox/quarto-template/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
49
+
- Open a new [Issue](https://github.com/rdatatoolbox/description-file/issues/new).
50
+
- Use the template [other_issue.md](https://github.com/rdatatoolbox/description-file/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
51
51
- Provide as much context as you can about what you're running into.
52
52
- Provide project and platform versions (paste the output of `sessionInfo()`).
53
53
@@ -63,19 +63,19 @@ We will then take care of the issue as soon as possible.
63
63
64
64
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
65
65
66
-
- Make sure that you are using the latest version of `quarto-template`.
66
+
- Make sure that you are using the latest version of `description-file`.
67
67
- Determine if your bug is really a bug and not an error on your side.
68
-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rdatatoolbox/quarto-template/issues?q=label%3Abug).
68
+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rdatatoolbox/description-file/issues?q=label%3Abug).
69
69
70
70
71
71
72
72
### How do I submit a bug report?
73
73
74
-
We use [GitHub Issues](https://github.com/rdatatoolbox/quarto-template/issues) to
74
+
We use [GitHub Issues](https://github.com/rdatatoolbox/description-file/issues) to
75
75
track bugs and errors. If you run into an issue with the project:
76
76
77
-
- Open a new [Issue](https://github.com/rdatatoolbox/quarto-template/issues/new).
78
-
- Use the template [bug_report.md](https://github.com/rdatatoolbox/quarto-template/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
77
+
- Open a new [Issue](https://github.com/rdatatoolbox/description-file/issues/new).
78
+
- Use the template [bug_report.md](https://github.com/rdatatoolbox/description-file/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
79
79
- Explain the behavior you would expect and the actual behavior.
80
80
- Please provide as much context as possible and describe the
81
81
*reproduction steps* that someone else can follow to recreate the issue on
@@ -91,21 +91,21 @@ We will then take care of the issue as soon as possible.
91
91
92
92
### Before requesting a feature
93
93
94
-
- Make sure that you are using the latest version of `quarto-template`.
95
-
- Read the [documentation](https://github.com/rdatatoolbox/quarto-template/) and the [wiki](https://github.com/rdatatoolbox/quarto-template/wiki) carefully and find out if the functionality is already covered.
96
-
- Perform a [search](https://github.com/rdatatoolbox/quarto-template/issues) to see if this enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
94
+
- Make sure that you are using the latest version of `description-file`.
95
+
- Read the [documentation](https://github.com/rdatatoolbox/description-file/) and the [wiki](https://github.com/rdatatoolbox/description-file/wiki) carefully and find out if the functionality is already covered.
96
+
- Perform a [search](https://github.com/rdatatoolbox/description-file/issues) to see if this enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
97
97
98
98
99
99
100
100
### How do I submit a feature request?
101
101
102
-
Feature requests are tracked as [GitHub Issues](https://github.com/rdatatoolbox/quarto-template/issues).
102
+
Feature requests are tracked as [GitHub Issues](https://github.com/rdatatoolbox/description-file/issues).
103
103
104
-
- Open a new [Issue](https://github.com/rdatatoolbox/quarto-template/issues/new).
105
-
- Use the template [feature_request.md](https://github.com/rdatatoolbox/quarto-template/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
104
+
- Open a new [Issue](https://github.com/rdatatoolbox/description-file/issues/new).
105
+
- Use the template [feature_request.md](https://github.com/rdatatoolbox/description-file/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
106
106
- Provide a clear and descriptive title for the issue to identify the suggestion.
107
107
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
108
-
- Explain why this enhancement would be useful to most `quarto-template` users.
108
+
- Explain why this enhancement would be useful to most `description-file` users.
109
109
110
110
We will then take care of the issue as soon as possible.
111
111
@@ -122,7 +122,7 @@ We use the [GitHub flow](https://docs.github.com/en/get-started/quickstart/githu
122
122
1. Make your contribution.
123
123
1. Stage (`git add`) and commit (`git commit`) your changes as often as necessary
124
124
1. Push your changes to GitHub w/ `git push origin branch-name`.
125
-
3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/rdatatoolbox/quarto-template/compare).
125
+
3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/rdatatoolbox/description-file/compare).
This repository contains files used to generate the online presentation [Quarto template](https://rdatatoolbox.github.io/quarto-template) based on [Quarto](https://quarto.org/) and the [RevealJS](https://quarto.org/docs/presentations/revealjs/) framework.
66
+
This repository contains files used to generate the online presentation [The `DESCRIPTION` file](https://rdatatoolbox.github.io/description-file) based on [Quarto](https://quarto.org/) and the [RevealJS](https://quarto.org/docs/presentations/revealjs/) framework.
76
67
77
68
78
69
## Usage
@@ -91,14 +82,14 @@ To understand the file organisation of this repository, please read this [Wiki](
91
82
92
83
## Citation
93
84
94
-
Casajus N (2024) _A Quarto template for HTML presentation with RevealJS framework_. Online presentation available at <https://github.com/rdatatoolbox/quarto-template/>.
85
+
Casajus N (2025) _The `DESCRIPTION` file: Store project metadata & dependencies in one place_. Online presentation available at <https://github.com/rdatatoolbox/description-file/>.
95
86
96
87
97
88
## Contributing
98
89
99
-
All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/rdatatoolbox/quarto-template/blob/main/CONTRIBUTING.md).
90
+
All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/rdatatoolbox/description-file/blob/main/CONTRIBUTING.md).
100
91
101
-
Please note that the `quarto-template` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
92
+
Please note that the `description-file` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
0 commit comments