Documentation enhancement with open science practices in sktime

[abdulelahsm]

Project Lead:

@afzal442 and @abdulelahsm

Mentor:

@tobyhodges

Welcome to OLS-3! This issue will be used to track your project and progress during the program. Please use this checklist over the next few weeks as you start Open Life Science program :tada:.

---

Week 1 (week starting 8 February 2021): Meet your mentor!

• [x] Create an account on GitHub
• [x] Check if you have access to the HackMD notes set up for your meetings with your mentor
• [x] Prepare to meet your mentor(s) by completing a short homework provided in the HackMD notes
• [x] Complete your own copy of the open leadership self-assessment and share it to your mentor If you're a group, each teammate should complete this assessment individually. This is here to help you set your own personal goals during the program. No need to share your results, but be ready to share your thoughts with your mentor.
• [x] Make sure you know when and how you'll be meeting with your mentor.

Before Week 2 (week starting 15 February 2021): Cohort Call (Welcome to Open Life Science!)

• [x] Create an issue on the OLS-3 GitHub repository for your OLS work and share the link to your mentor.

• [x] Draft a brief vision statement using your goals

  This lesson from the Open Leadership Training Series (OLTS) might be helpful

• [x] Leave a comment on this issue with your draft vision statement & be ready to share this on the call

• [x] Check the Syllabus for notes and connection info for all the cohort calls.

Before Week 3 (week starting 22 February 2021): Meet your mentor!

• [ ] Look up two other projects and comment on their issues with feedback on their vision statement
• [ ] Complete this compare and contrast assignment about current and desired community interactions and value exchanges
• [ ] Complete your Open Canvas (instructions, canvas)
• [ ] Share a link to your Open Canvas in your GitHub issue
• [ ] Start your Roadmap
• [ ] Comment on your issue with your draft Roadmap
• [ ] Suggest a cohort name at the bottom of the shared notes and vote on your favorite with a +1

Before Week 4 (week starting 1 March 2021): Cohort Call (Tooling and roadmapping for Open projects)

• [ ] Look up two other projects and comment on their issues with feedback on their open canvas.

Week 5 and later

• [x] Create a GitHub repository for your project
• [ ] Add the link to your repository in your issue
• [ ] Use your canvas to start writing a README.md file, or landing page, for your project
• [ ] Link to your README in a comment on this issue
• [ ] Add an open license to your repository as a file called LICENSE.md
• [ ] Add a Code of Conduct to your repository as a file called CODE_OF_CONDUCT.md
• [ ] Invite new contributors to into your work!

This issue is here to help you keep track of work as you start Open Life Science program. Please refer to the OLS-3 Syllabus for more detailed weekly notes and assignments past week 4.

[abdulelahsm]

@afzal442 please complete the following tasks and comment on the issue with the outcome

• [ ] Look up two other projects and comment on their issues with feedback on their vision statement
• [ ] Complete this compare and contrast assignment about current and desired community interactions and value exchanges
• [ ] Complete your Open Canvas (instructions, canvas)
• [ ] Share a link to your Open Canvas in your GitHub issue
• [ ] Start your Roadmap
• [ ] Comment on your issue with your draft Roadmap
• [ ] Suggest a cohort name at the bottom of the shared notes and vote on your favorite with a +1

[abdulelahsm]

Vision statement that was shared during the call by @abdulelahsm : "to make it easier for users and developers of sktime to recognize their contributions more visibly and formally to encourage long-term maintenance of their contributions"

[afzal442]

Open Canvas

https://docs.google.com/presentation/d/1kgu-Nxm_ycjKiQMeWLfgHOOPc5fZtsK_Ps_LYau7b_U/edit?usp=sharing

[martinagvilas]

Sounds like a great project!

One question I had after reading your vision statement:

"to make it easier for users and developers of sktime to recognize their contributions more visibly and formally to encourage long-term maintenance of their contributions"

Is the encouragement of long-term contributions a separate goal from the recognition one? Will both of them be achieved using the same method? Or is the long-term maintenance of contributions the impact you are hoping to make in the long run by improving the recognition of contributions?

[abdulelahsm]

@martinagvilas Hey Martina! thanks for your comments.

Is the encouragement of long-term contributions a separate goal from the recognition one?

Great question. I believe that they go hand in hand. As you said, the maintenance of contributions is the impact and the way we framed the vision statement was to clarify why should we make it easier to recognize contributors.

[afzal442]

GitHub Repo Link

DocumentationEnhancementAtsktime