From 5b29214c80796edfc323c4a3f895b4c5a8fd1c97 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Thu, 14 Sep 2023 08:47:47 +0100 Subject: [PATCH 1/4] Added an exercise/top tips for collaboration --- episodes/wrap-up3.md | 58 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/episodes/wrap-up3.md b/episodes/wrap-up3.md index 13c8be52f..7cb6dcf3c 100644 --- a/episodes/wrap-up3.md +++ b/episodes/wrap-up3.md @@ -20,10 +20,66 @@ After completing this episode, participants should be able to... :::::::::::::::::::::::::::::::::::::::::::::::::: +We have reached the end of this training. + +## Looking Back + +Throughout this training we promoted a collaborative approach to lesson development and maintenance (as many other initiatives in The Carpentries community are conducted). Collaboration helps bring different skills and perspectives to a project and share the load of the work required to bring the project successfully past the finishing line. For lesson projects, this shared effort also extends to maintaining and updating the lesson after the initial development phase. + +::::::::::::: challenge + +# Exercise: What steps can you take to be a good collaborator? (20 minutes) + +Spend some time exploring at least two of the following lesson repositories: + +- [Collaborative Lesson Development Training](https://github.com/carpentries/lesson-development-training) (this lesson) +- [Library Carpentry: Introduction to Working with Data (Regular Expressions)](https://github.com/librarycarpentry/lc-data-intro/) (official Library Carpentry lesson) +- [Introduction to Geospatial Raster and Vector Data with Python](https://github.com/carpentries-incubator/geospatial-python) (in Carpentries Incubator) +- [Introduction to R for Metagenomics](https://github.com/carpentries-lab/metagenomics-R) (in Carpentries Lab) + +and noting down what things you noticed in these repositories that could aid collaboration. Trainers will then lead a discussion on what people found and steps you could take to improve your lesson repository. + +::: solution + +While you will know the best collaboration practices for your team, here are some suggestions/top tips: + + 1. Provide ‘external-facing’ features for your lesson (such as description, objectives, contribution and 'how to get involved' + guides, preferred way of communication) - these will be universally useful for everyone coming to your repository (your team included). + + 2. Find the best tools that work for your team for communication, documentation and knowledge sharing, issue & project management. + + 3. Document and share knowledge within the team to facilitate team collaboration. Share decisions and communicate with your team synchronously and asynchronously. + + 4. Plan your meetings to get the most out of your team (e.g. set agenda, assign meeting roles - chair, note-taker, time-keeper, etc.) + and be appreciative of people's times. + + 5. Record and manage issues with your lesson as you develop, trial and maintain it (e.g. assign people responsible for + issues, categorise and prioritise them). + + 6. Assign tasks and roles to distribute the responsibilities - this includes assigning larger roles (project management + & governance) to team members and assigning specific issues/tasks to collaborators. Progress is much more likely to be made + when people know what they and others should be working on. + + 7. Dedicated sprints where the whole team works on a set of issues towards a milestone work well for lesson development and making progress on projects in general. + + 8. Be open and welcoming to new contributors and provide different opportunities to get involved with your project + (from novice to expert collaborators). Point to upskilling guides (or run upskilling sessions if possible) to bring people + up to speed. Show appreciation for everyone's contributions. + + 9. Manage contributions in a timely manner by noticing when things happen and responding to new issues, comments and + Pull Requests (PRs). Show appreciation for everyone's contributions. + + 10. People bring different perspectives, expertise and skills to a collaborative project and, while they can be productive + and harmoniously complement each other, having some decision making and conflict resolution process in place will make sure + progress can be made when disagreements arise. + +::: + +::::::::::::: + ## Looking Ahead -We have reached the end of this training. By now, you should have made good progress towards a first draft of your lesson. Referring back to [the life cycle stages for lessons](operations.md) From b1cfb8613facdef9096b8f4c31efbc2050d2a3e1 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Thu, 14 Sep 2023 14:28:35 +0100 Subject: [PATCH 2/4] Update episodes/wrap-up3.md --- episodes/wrap-up3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/episodes/wrap-up3.md b/episodes/wrap-up3.md index 7cb6dcf3c..c163d38e6 100644 --- a/episodes/wrap-up3.md +++ b/episodes/wrap-up3.md @@ -64,7 +64,7 @@ While you will know the best collaboration practices for your team, here are som 8. Be open and welcoming to new contributors and provide different opportunities to get involved with your project (from novice to expert collaborators). Point to upskilling guides (or run upskilling sessions if possible) to bring people - up to speed. Show appreciation for everyone's contributions. + up to speed. 9. Manage contributions in a timely manner by noticing when things happen and responding to new issues, comments and Pull Requests (PRs). Show appreciation for everyone's contributions. From 99c87feaa6c868dcf8e98da9f3d882e17e4e7bd3 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Mon, 18 Sep 2023 14:07:35 +0100 Subject: [PATCH 3/4] Update episodes/wrap-up3.md Co-authored-by: Toby Hodges --- episodes/wrap-up3.md | 49 ++++++++++++++++++-------------------------- 1 file changed, 20 insertions(+), 29 deletions(-) diff --git a/episodes/wrap-up3.md b/episodes/wrap-up3.md index c163d38e6..cbbcc667d 100644 --- a/episodes/wrap-up3.md +++ b/episodes/wrap-up3.md @@ -43,35 +43,26 @@ and noting down what things you noticed in these repositories that could aid col While you will know the best collaboration practices for your team, here are some suggestions/top tips: - 1. Provide ‘external-facing’ features for your lesson (such as description, objectives, contribution and 'how to get involved' - guides, preferred way of communication) - these will be universally useful for everyone coming to your repository (your team included). - - 2. Find the best tools that work for your team for communication, documentation and knowledge sharing, issue & project management. - - 3. Document and share knowledge within the team to facilitate team collaboration. Share decisions and communicate with your team synchronously and asynchronously. - - 4. Plan your meetings to get the most out of your team (e.g. set agenda, assign meeting roles - chair, note-taker, time-keeper, etc.) - and be appreciative of people's times. - - 5. Record and manage issues with your lesson as you develop, trial and maintain it (e.g. assign people responsible for - issues, categorise and prioritise them). - - 6. Assign tasks and roles to distribute the responsibilities - this includes assigning larger roles (project management - & governance) to team members and assigning specific issues/tasks to collaborators. Progress is much more likely to be made - when people know what they and others should be working on. - - 7. Dedicated sprints where the whole team works on a set of issues towards a milestone work well for lesson development and making progress on projects in general. - - 8. Be open and welcoming to new contributors and provide different opportunities to get involved with your project - (from novice to expert collaborators). Point to upskilling guides (or run upskilling sessions if possible) to bring people - up to speed. - - 9. Manage contributions in a timely manner by noticing when things happen and responding to new issues, comments and - Pull Requests (PRs). Show appreciation for everyone's contributions. - - 10. People bring different perspectives, expertise and skills to a collaborative project and, while they can be productive - and harmoniously complement each other, having some decision making and conflict resolution process in place will make sure - progress can be made when disagreements arise. +1. Provide ‘external-facing’ features for your lesson (such as description, objectives, contribution and 'how to get involved' + guides, preferred way of communication) - these will be universally useful for everyone coming to your repository (your team included). +2. Find the best tools that work for your team for communication, documentation and knowledge sharing, issue & project management. +3. Document and share knowledge within the team to facilitate team collaboration. Share decisions and communicate with your team synchronously and asynchronously. +4. Plan your meetings to get the most out of your team (e.g. set agenda, assign meeting roles - chair, note-taker, time-keeper, etc.) + and be appreciative of people's times. +5. Record and manage issues with your lesson as you develop, trial and maintain it (e.g. assign people responsible for + issues, categorise and prioritise them). +6. Assign tasks and roles to distribute the responsibilities - this includes assigning larger roles (project management + & governance) to team members and assigning specific issues/tasks to collaborators. Progress is much more likely to be made + when people know what they and others should be working on. +7. Dedicated sprints where the whole team works on a set of issues towards a milestone work well for lesson development and making progress on projects in general. +8. Be open and welcoming to new contributors and provide different opportunities to get involved with your project + (from novice to expert collaborators). Point to upskilling guides (or run upskilling sessions if possible) to bring people + up to speed. +9. Manage contributions in a timely manner by noticing when things happen and responding to new issues, comments and + Pull Requests (PRs). Show appreciation for everyone's contributions. +10. People bring different perspectives, expertise and skills to a collaborative project and, while they can be productive + and harmoniously complement each other, having some decision making and conflict resolution process in place will make sure + progress can be made when disagreements arise. ::: From 35e6912aca5e2005ef4f02895997fd8431559d27 Mon Sep 17 00:00:00 2001 From: Aleksandra Nenadic Date: Tue, 19 Sep 2023 14:44:10 +0100 Subject: [PATCH 4/4] Moved top tips outside the exercise which is now discussion. --- episodes/wrap-up3.md | 50 +++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/episodes/wrap-up3.md b/episodes/wrap-up3.md index cbbcc667d..d8c7b2dae 100644 --- a/episodes/wrap-up3.md +++ b/episodes/wrap-up3.md @@ -24,50 +24,48 @@ We have reached the end of this training. ## Looking Back -Throughout this training we promoted a collaborative approach to lesson development and maintenance (as many other initiatives in The Carpentries community are conducted). Collaboration helps bring different skills and perspectives to a project and share the load of the work required to bring the project successfully past the finishing line. For lesson projects, this shared effort also extends to maintaining and updating the lesson after the initial development phase. +Throughout this training we promoted a collaborative approach to lesson development (as many other initiatives in The Carpentries community are conducted). Collaboration helps bring different skills and perspectives to a project and share the load of the work required to bring the project successfully past the finishing line. For lesson projects, this shared effort also extends to maintaining and updating the lesson after the initial development phase. -::::::::::::: challenge +::::::::::::: discussion -# Exercise: What steps can you take to be a good collaborator? (20 minutes) +## Exercise: What steps can you take to be a good collaborator? (20 minutes) -Spend some time exploring at least two of the following lesson repositories: +Spend some time reflecting on collaboration aspects we covered in this training and exploring at least two of the +following lesson repositories, noting down what things you noticed in these repositories that could aid collaboration: - [Collaborative Lesson Development Training](https://github.com/carpentries/lesson-development-training) (this lesson) -- [Library Carpentry: Introduction to Working with Data (Regular Expressions)](https://github.com/librarycarpentry/lc-data-intro/) (official Library Carpentry lesson) -- [Introduction to Geospatial Raster and Vector Data with Python](https://github.com/carpentries-incubator/geospatial-python) (in Carpentries Incubator) -- [Introduction to R for Metagenomics](https://github.com/carpentries-lab/metagenomics-R) (in Carpentries Lab) +- [Introduction to Working with Data (Regular Expressions)](https://github.com/librarycarpentry/lc-data-intro/) official Library Carpentry lesson +- [Introduction to Geospatial Raster and Vector Data with Python](https://github.com/carpentries-incubator/geospatial-python) lesson in Carpentries Incubator +- [Introduction to R for Metagenomics](https://github.com/carpentries-lab/metagenomics-R) lesson in Carpentries Lab -and noting down what things you noticed in these repositories that could aid collaboration. Trainers will then lead a discussion on what people found and steps you could take to improve your lesson repository. +Trainers will then lead a discussion on what people found and steps you could take to improve your lesson repository. -::: solution +::::::::::::: + +### Collaboration Top Tips -While you will know the best collaboration practices for your team, here are some suggestions/top tips: +While you will know the best collaboration practices for your team, here are some suggestions: 1. Provide ‘external-facing’ features for your lesson (such as description, objectives, contribution and 'how to get involved' guides, preferred way of communication) - these will be universally useful for everyone coming to your repository (your team included). 2. Find the best tools that work for your team for communication, documentation and knowledge sharing, issue & project management. 3. Document and share knowledge within the team to facilitate team collaboration. Share decisions and communicate with your team synchronously and asynchronously. -4. Plan your meetings to get the most out of your team (e.g. set agenda, assign meeting roles - chair, note-taker, time-keeper, etc.) +4. Plan your meetings to get the most out of your team (e.g. set agenda, assign meeting roles - chair, note-taker, time-keeper, etc.) and be appreciative of people's times. -5. Record and manage issues with your lesson as you develop, trial and maintain it (e.g. assign people responsible for +5. Record and manage issues with your lesson as you develop, trial and maintain it (e.g. assign people responsible for issues, categorise and prioritise them). -6. Assign tasks and roles to distribute the responsibilities - this includes assigning larger roles (project management - & governance) to team members and assigning specific issues/tasks to collaborators. Progress is much more likely to be made +6. Assign tasks and roles to distribute the responsibilities - this includes assigning larger roles (project management + & governance) to team members and assigning specific issues/tasks to collaborators. Progress is much more likely to be made when people know what they and others should be working on. 7. Dedicated sprints where the whole team works on a set of issues towards a milestone work well for lesson development and making progress on projects in general. -8. Be open and welcoming to new contributors and provide different opportunities to get involved with your project - (from novice to expert collaborators). Point to upskilling guides (or run upskilling sessions if possible) to bring people +8. Be open and welcoming to new contributors and provide different opportunities to get involved with your project + (from novice to expert collaborators). Point to upskilling guides (or run upskilling sessions if possible) to bring people up to speed. -9. Manage contributions in a timely manner by noticing when things happen and responding to new issues, comments and - Pull Requests (PRs). Show appreciation for everyone's contributions. -10. People bring different perspectives, expertise and skills to a collaborative project and, while they can be productive - and harmoniously complement each other, having some decision making and conflict resolution process in place will make sure - progress can be made when disagreements arise. - -::: - -::::::::::::: - +9. Manage contributions in a timely manner by noticing when things happen and responding to new issues, comments and + Pull Requests (PRs). Show appreciation for everyone's contributions. +10. People bring different perspectives, expertise and skills to a collaborative project and, while they can be productive + and harmoniously complement each other, having some decision making and conflict resolution process in place will make sure + progress can be made when disagreements arise. ## Looking Ahead