Skip to content

Commit 48ecbdd

Browse files
authored
Update README.md for USRSE'25
1 parent 642ad2c commit 48ecbdd

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Continuous Integration (CI) resources for US-RSE'24 computational notebooks submissions
1+
# Continuous Integration (CI) resources for US-RSE'25 computational notebooks submissions
22

3-
This repository contains instructions, GitHub Actions workflows, and accessory scripts to help authors tests their submissions for the Computational Notebooks track at the [US-RSE'24 conference](https://USRSE.github.io/usrse24).
3+
This repository contains instructions, GitHub Actions workflows, and accessory scripts to help authors tests their submissions for the Computational Notebooks track at the [US-RSE'25 conference](https://USRSE.github.io/usrse25).
44

55
## In a nutshell
66

7-
- We have developed an **automated workflow** to test that a repository satisfies the **requirements for submission to the US-RSE'24 notebooks track**, and that the **notebook can be run in the same standardized, self-contained environment** that will be used during the review process
7+
- We have developed an **automated workflow** to test that a repository satisfies the **requirements for submission to the US-RSE'25 notebooks track**, and that the **notebook can be run in the same standardized, self-contained environment** that will be used during the review process
88
- Authors **can, but are not required to, enable this workflow** to validate their repository at any stage, including while developing their notebook and/or before finalizing their submission
99
- To enable the workflow and start testing your repository, refer to the [Getting Started guide](docs/getting-started.md) in this repository
1010

@@ -29,9 +29,9 @@ This repository contains instructions, GitHub Actions workflows, and accessory s
2929
- Even if **authors** try their best to **provide resources for reproducing a valid computational environment** in which their submission can be run (such as documentation, packaging/environment metadata, etc), the **lack of an automated way to test and a documented standard for the computational environment** that will be used limits their ability to validate their resources (and, therefore, estimating how likely it is that their notebooks will run as expected during review) before finalizing their submission
3030
- By providing **a set of automated checks that can run on the repository before submission**, based on the **same standardized tools, specifications, and computational environment available to reviewers**, the CI workflow addresses both of these issues, giving authors the possibility to **focus their efforts toward a concrete goal for computational reproducibility** for their US-RSE notebooks submission, hopefully only requiring a reasonable amount of extra effort
3131

32-
### I'm interested in submitting a notebook to US-RSE'24, but I'm not sure about this CI thing. Am I still able to submit without it?
32+
### I'm interested in submitting a notebook to US-RSE'25, but I'm not sure about this CI thing. Am I still able to submit without it?
3333

34-
- In one sentence: **absolutely, yes!** Using this CI workflow **is not a requirement for submission** for US-RSE'24
34+
- In one sentence: **absolutely, yes!** Using this CI workflow **is not a requirement for submission** for US-RSE'25
3535
- **Using this CI workflow is completely optional**. Authors who choose not to enable it for their repository for any reason will not be penalized in any way, as long as their repository satisfies the mandatory requirements described in the submission instructions
3636

3737
### What do I have to do to enable the US-RSE notebooks CI workflow for my GitHub repository?
@@ -40,7 +40,9 @@ Refer to the [Getting Started](docs/getting-started.md) section of the [document
4040

4141
## Next steps
4242

43-
If you're interested to know more about the US-RSE'24 notebooks submissions:
43+
If you're interested to know more about the US-RSE'25 notebooks submissions:
4444

45-
- Join the `#usrse24` channel on the US-RSE Slack workspace to receive general news about the conference, as well as updates specific to the notebooks CI resources hosted in this repository
45+
- Join the `#usrse25` channel on the US-RSE Slack workspace to receive general news about the conference, as well as updates specific to the notebooks CI resources hosted in this repository
4646
- Star this repository to receive notifications about new versions, functionality being added, etc
47+
48+
If you have any questions, please email [email protected].

0 commit comments

Comments
 (0)