Skip to content

Commit

Permalink
Update contributing.qmd
Browse files Browse the repository at this point in the history
  • Loading branch information
noramcgregor authored Jun 24, 2024
1 parent c5f7332 commit 200f482
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions book/contributing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Feel free to contact [Nora McGregor](mailto:[email protected]) if you're kee

- Contribute a new [Topic Guide](topicguides.qmd) (individually or in collaboration with others). Choose from our [existing wishlist](https://docs.google.com/spreadsheets/d/1FYR9UyZ7lWJOfsucZspw5sm9rmnTtHXecaYpCbVvDdI/edit#gid=851320609) or propose a new one. Join an upcoming writing sprint or get in touch with us directly to discuss [[email protected]](mailto:[email protected]) your idea and we'll help you get started right away!

> **_NOTE:_** Specific Topic Guides that we are seeking authors for include:
> **_NOTE:_** Topic Guides we are seeking authors for right now include:
>
>- Automatic Text Transcription (OCR/HTR)
>- Demystifying Computational Environments for Digital Scholarship
Expand All @@ -19,7 +19,7 @@ Feel free to contact [Nora McGregor](mailto:[email protected]) if you're kee
>- Digital Scholarship/Data Science Project Management, Evaluation and Impact Assessment
>- Foundation models: When and why to use LLMs or SLMs
- Suggest edits to an existing Topic Guide or Additional Resources by opening a new [Issue](https://github.com/libereurope/ds-essentials/issues) or adding to the discussion on existing ones on the project Github**. If you're new to GitHub don't worry, we have a Topic Guide for that: [GitHub: How to navigate and contribute to Git-based projects](https://libereurope.github.io/ds-essentials/github.html)!
- Suggest edits to an existing [Topic Guide](topicguides.qmd) or any of the General Resources pages by opening a new [Issue](https://github.com/libereurope/ds-essentials/issues) or adding to the discussion on existing Issues on the project Github. If you're new to GitHub don't worry, we have a Topic Guide for that: [GitHub: How to navigate and contribute to Git-based projects](https://libereurope.github.io/ds-essentials/github.html)!
- Join one of the [LIBER Working Groups Digital Scholarship and Digital Cultural Heritage WG](https://libereurope.eu/working-group/digital-scholarship-and-digital-cultural-heritage-collections-working-group/) or [Data Science in Libraries](https://libereurope.eu/working-group/liber-data-science-in-libraries-working-group/) (open to all staff of [LIBER member institutions](https://libereurope.eu/liber-participants/)) to keep up with the developments and ongoing maintenance of this project!

## Join a Writing Sprint!
Expand All @@ -44,13 +44,9 @@ A two hour writing sprint will generally follow this format:

### After the sprint:

During the sprint, you’ve drafted your Topic Guide in a Google Doc. This Google Doc can continue to serve as a ‘living document’ following the sprint until you feel the content is ready to be published. Throughout this process, we will use your Github issue to maintain an overview of the docs in terms of their status and action points so please keep this updated. Each Topic Guide will be allocated a specific Maintainer contact (one of the co-chairs) who will be in touch and work with you to see the process through to completion.
During the sprint, you’ve drafted your Topic Guide in a Google Doc. This Google Doc can continue to serve as a ‘living document’ following the sprint until you feel the content is ready to be published. Throughout this process, we will use your Github issue to maintain an overview of the docs in terms of their status and action points so please keep this updated. Each Topic Guide will be allocated a specific Maintainer contact (one of the co-chairs) who will be in touch and work with you to see the process through to completion. You may request placing your Google Doc under restricted access if you wish. We will not do this by default, but we respect that some contributors would like to keep drafts private until fully ready for submission.

Things to note when creating and working with the Issue Template for your newly created Topic Guide:

- You may request placing your Google Doc under restricted access if you wish. We will not do this by default, but we respect that some contributors would like to keep drafts private until fully ready for submission.

When your Topic Guide is ready for our review in Google Docs, please let us know by logging an update over on Github as a comment on the Issue stating this. You can also tag the maintainers so they receive a notification as well. Maintainers will generally work with you on the final edits necessary for the submission through track changes and comments within the Google Doc itself. Once these have all been resolved maintainers will log a status update indicating “Review complete; Final Submission Ready; Make live” in the GitHub issue.
When your Topic Guide is ready for our review in Google Docs, please let us know by logging an update over on Github as a comment on the Issue stating this. You can also tag the maintainers so they receive a notification as well. Maintainers will generally work with you on the final edits necessary for the submission through track changes and comments within the Google Doc itself. Once these have all been resolved maintainers will log a status update in the GitHub issue.

## Ongoing Maintenance and Review

Expand Down

0 comments on commit 200f482

Please sign in to comment.