Skip to content

Commit 60123f5

Browse files
JosiahParryJosiahParry
authored
Merge pull request #17 from RConsortium/main
update proposal template
2 parents de46062 + 5e3a745 commit 60123f5

13 files changed

Lines changed: 168 additions & 140 deletions

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ vignettes/*.pdf
1616
# File gen artefacts
1717
*.html
1818
*.pdf
19+
20+
/.quarto/

‎README.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
# isc-proposal
1+
# 🚧🚧🚧 UNDER CONSTRUCTION: isc-proposal 🚧🚧🚧
2+
3+
This repository is currently being revisited.
4+
An update will be released in early September 2025.
25

36
[![build-status](https://github.com/YOUR-USERNAME/YOUR-REPOSITORY/actions/workflows/publish-proposal.yaml/badge.svg)](https://github.com/YOUR-USERNAME/YOUR-REPOSITORY/actions/workflows/publish-proposal.yaml)
47

58
This repository is a boilerplate repository that helps you prepare your proposal for the [R Consortium](https://www.r-consortium.org).
69

7-
## Background
10+
## Background
811

912
Set up in 2015, the R Consortium is an organisation set up to help support the R Foundation, the R Community, and R users.
1013

11-
> The primary purpose of the R Consortium (collectively, the “Purpose”) is to:
14+
> The primary purpose of the R Consortium (collectively, the “Purpose”) is to:
1215
>
1316
>(a) advance the worldwide promotion of and support for the R open source language and environment as the preferred language for statistical computing and graphics (the “Environment”);
1417
>
15-
>(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment;
18+
>(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment;
1619
>
17-
>(c) encourage and increase user adoption, involvement with, and contribution to, the Environment;
20+
>(c) encourage and increase user adoption, involvement with, and contribution to, the Environment;
1821
>
19-
>(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”);
22+
>(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”);
2023
>
21-
>(e) support and maintain policies set by the Board; and
24+
>(e) support and maintain policies set by the Board; and
2225
>
23-
>(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above.
26+
>(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above.
2427
>
2528
>In furtherance of these efforts, the R Consortium shall seek to solicit the participation of all interested parties on a fair, equitable and open basis.
2629
@@ -44,11 +47,11 @@ This is a boilerplate repository that you will need to fork, title appropriately
4447

4548
- Use the "Use this template" button on GitHub
4649
- Create a new repository with a name to reflect your proposal
47-
- Create a new Rstudio project from version control and use the git URL for the repo
50+
- Create a new Positron/RStudio/IDE project from version control and use the git URL for the repo
4851
- Write an overview of the proposal instead of this boilerplate for the README
49-
- Start completing the relevant Rmd pages of the proposal
52+
- Start completing the relevant qmd pages of the proposal
5053
- Render `isc-proposal.qmd` to build the document locally
51-
- Regularly commit and push the changes to github
54+
- Regularly commit and push the changes to GitHub
5255
- Solicit feedback and contributions from others
5356

5457
### Automatically generate your proposal

‎_quarto.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
project:
2+
title: "Isc-proposal"
3+
render:
4+
- "*.qmd"
5+
- "!proposal/"

‎isc-proposal.qmd‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,39 @@
11
---
22
title: "Proposal Title"
3-
author:
3+
author:
44
- name: Annie Easley
55
orcid: 5555-5555-5555-5555
66
affiliations:
77
- "Lewis Research Center, National Aeronautics and Space Administration"
8-
8+
99
date: today
1010
date-format: iso
1111
format:
1212
html:
1313
embed-resources: true
1414
hikmah-pdf:
15-
geometry:
15+
geometry:
1616
- left=1.25in
1717
- right=1.25in
1818
bibliography: references.bib
1919
---
2020

21-
{{< include proposal/signatories.qmd >}}
21+
# 🚧🚧🚧 UNDER CONSTRUCTION 🚧🚧🚧
22+
23+
This repository is currently being revisited.
24+
An update will be released in early September 2025.
25+
26+
{{< include proposal/00-exec-summary.qmd >}}
2227

23-
{{< include proposal/problemdefinition.qmd >}}
28+
{{< include proposal/01-signatories.qmd >}}
2429

25-
{{< include proposal/proposal.qmd >}}
30+
{{< include proposal/02-problemdefinition.qmd >}}
2631

27-
{{< include proposal/timeline.qmd >}}
32+
{{< include proposal/03-proposal.qmd >}}
2833

29-
{{< include proposal/requirements.qmd >}}
34+
{{< include proposal/04-timeline.qmd >}}
3035

31-
{{< include proposal/success.qmd >}}
36+
{{< include proposal/06-success.qmd >}}
3237

3338
::: refs
34-
:::
39+
:::

‎proposal/00-exec-summary.qmd‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Executive Summary
2+
3+
<!--
4+
This section provides a condensed view of the entire proposal, one page long.
5+
It should be a comprehensive high-level overview that captures the essence of the proposal, including its goals, methods, expected outcomes, deliverables, and budget.
6+
-->

proposal/signatories.qmd renamed to proposal/01-signatories.qmd

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# Signatories
2-
<!--
2+
<!--
33
This section provides the ISC with a view of the support received from
44
the community for a proposal. Acceptance isn't predicated on
5-
popularity but community acceptance is important. Willingness to
5+
popularity but community acceptance is important. Willingness to
66
accept outside input is also a good marker for project delivery.
77
88
An optional section would be for R-Core signatories where changes to R
99
are proposed.
1010
-->
1111

1212
## Project team
13-
<!--
13+
<!--
1414
Who are the people responsible for actually delivering the project if
1515
the proposal gets accepted and are already signed up and rearing to
16-
go?
16+
go? Briefly describe all participants and the skills they will bring
17+
to the project.
1718
-->
1819

1920
## Contributors
20-
<!--
21+
<!--
2122
Who are the people who have actively helped with this proposal but
2223
won't necessarily be on the core project team later?
2324
-->
2425

2526
## Consulted
26-
<!--
27+
<!--
2728
Who has been given the opportunity to provide feedback on the
2829
proposal? This should include any R Consortium & ISC members who the
2930
proposal has been discussed with.

proposal/problemdefinition.qmd renamed to proposal/02-problemdefinition.qmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ bibliography: references.bib
55
# The Problem
66

77
```{=html}
8-
<!--
8+
<!--
99
Outlining the issue / weak point / problem to be solved by this
1010
proposal. This should be a compelling section that sets the reader up
1111
for the next section - the proposed solution!
@@ -14,8 +14,10 @@ It is important to cover:
1414
1515
- [ ] What the problem is
1616
- [ ] Who it affects
17-
- [ ] Have there been previous attempts to resolve the problem
18-
- [ ] Why it should be tackled
17+
- [ ] Why is it a problem
18+
- [ ] What will solving the problem enable (why should it be solved)
19+
- [ ] Brief summary of existing work and previous attempts (e.g., relevant R packages)
20+
- [ ] If proposing changes to R itself: letter of support from R Core member
1921
-->
2022
```
2123

‎proposal/03-proposal.qmd‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# The proposal
2+
<!--
3+
How are you going to solve the problem? Include the concrete actions you
4+
will take and an estimated timeline. What are likely failure modes and
5+
how will you recover from them?
6+
7+
This is where the proposal should be outlined.
8+
-->
9+
10+
## Overview
11+
<!--
12+
At a high-level address what your proposal is and how it will address
13+
the problem identified. Highlight any benefits to the R Community that
14+
follow from solving the problem. This should be your most compelling
15+
section.
16+
17+
Include concrete actions you will take and estimated timeline.
18+
-->
19+
20+
## Detail
21+
<!--
22+
Go into more detail about the specifics of the project and how it delivers
23+
against the problem.
24+
25+
Depending on project type the detail section should include:
26+
-->
27+
28+
### Minimum Viable Product
29+
30+
<!--
31+
What is the smallest thing you can build that delivers value to your users?
32+
-->
33+
34+
### Architecture
35+
36+
<!--
37+
What does the high-level architecture look like?
38+
-->
39+
40+
### Assumptions
41+
42+
<!--
43+
What assumptions are you making that, if proven false, would invalidate the project?
44+
-->
45+
46+
### External dependencies
47+
48+
<!--
49+
What external dependencies does the project have (e.g. libraries, services, other projects, etc.)?
50+
-->

‎proposal/04-timeline.qmd‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Project plan
2+
3+
## Start-up phase
4+
<!--
5+
Covering the planning phase, this section should provide a relatively
6+
detailed plan of how work will start on the project. This section is
7+
important because projects need to get up and running quickly.
8+
9+
10+
- [ ] Setting up collaboration platform inc. code for contributors etc.
11+
- [ ] Licence decisions
12+
- [ ] Reporting framework
13+
-->
14+
15+
16+
## Technical delivery
17+
<!--
18+
Covering the actual delivery of the project this section should
19+
provide at least a high-level description of the implementation.
20+
21+
Including target dates is really important as you need to be committed
22+
and the ISC need to have a means of tracking delivery
23+
-->
24+
25+
## Other aspects
26+
27+
<!--
28+
How will you ensure that your work is available to the widest number
29+
of people? Please specify the open-source or creative commons license(s)
30+
you will use, how you will host your code so that others can contribute,
31+
and how you will publicize your work. We encourage you to plan content
32+
to be shared quarterly on the R Consortium blog.
33+
34+
- [ ] Announcement post
35+
- [ ] Delivery blog post
36+
- [ ] Social media
37+
- [ ] UseR!
38+
- [ ] ISC meetings
39+
-->
40+
41+
## Budget & funding plan
42+
43+
<!--
44+
Outline the milestones for development and how much funding will be
45+
required for each stage (as payments will be tied to project milestone
46+
completion). Each milestone should specify the work to be done and the
47+
expected outcomes, providing enough detail for the ISC to understand
48+
the scope of the project work and assess the likelihood of success.
49+
50+
We expect that most of the budget will be allocated
51+
for labor costs. We do not cover indirect costs. The ISC grants cannot
52+
cover such things as travel, lodging, food, journal publication fees,
53+
or personal hardware. Cloud services may be covered if they are specific
54+
to the project and the project period. The ISC reserves the right to vet
55+
how funds are used for each project separately. If in doubt, please reach
56+
out to us.
57+
-->
58+
59+
## Budget

proposal/success.qmd renamed to proposal/06-success.qmd

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,22 @@
11
# Success
2-
<!--
2+
<!--
33
Projects should have a definition of done that is measurable, and a
44
thorough understanding going in of what the risks are to delivery
55
-->
66

77
## Definition of done
8-
<!--
9-
What does success look like?
8+
<!--
9+
What does success look like?
1010
-->
1111

1212
## Measuring success
13-
<!--
13+
<!--
1414
How will we know when success is achieved, what markers can we use
1515
along the way
1616
-->
1717

1818
## Future work
19-
<!--
19+
<!--
2020
How could this be extended / developed in the future by yourself
2121
and/or the community in general?
2222
-->
23-
24-
## Key risks
25-
<!--
26-
What sort of things could come up that can delay or break the project?
27-
28-
- [ ] People
29-
- [ ] Processes
30-
- [ ] Tooling & Technology
31-
- [ ] Costs
32-
33-
-->

0 commit comments

Comments
 (0)