Tasks for Interns on Probation - petermr/CEVOpen GitHub Wiki

TABLE OF CONTENTS

1. All you as an incoming Intern on probation need to know:

CEVOpen is an online platform for remote internships during the Pandemic, conducted at the interface of NIPGR, India and the University of Cambridge, U.K.

We would like you to go through our main GitHub repository to familiarize yourself with the workflow, software, project, and so on. The Wiki Home page is a good place to start. We are an open-source community. Please make sure to read the Code of Conduct and adhere to it. It basically says, "be respectable and helpful towards everyone".

For the first week or two, you will be assigned certain tasks which you should try completing independently. You should also document your steps as you go. This isn’t an exam.

Just like how you document your testing and installation in the probation period, you will work in public (i.e., on Slack and GitHub) if you are officially inducted into the program.

1.1. What we expect

  • Information on other known commitments (college, exams, and so on)
  • Correct equipment at your end
  • Clear writing and communication skills
  • Prior experience with running software
  • Interactions on a daily basis through stand-ups

1.2. What you can expect

Collaborative workspace

  • An opportunity to learn transferable skills
  • An introduction to the open-source community ...

1.3. What you should record while performing tasks

Recording what you perform is crucial to the project. Proper documentation helps reproduce the same task, debug errors and so on.

Here is a Wiki section on how to report errors. Though it talks about error reporting, a lot of those principles are true for documentation as well.

In short, when you are running our tools, make sure to note down:

  • What commands you ran
  • What you expected it to do
  • Results you get
  • Errors, if any Comments and feedback on how to improve our existing documentation would be useful. Avoid screenshots and always format your code in the code block using backticks.

2. Assigned Tasks for the probation period

Assuming you have installed git and python, follow the prerequisites section to install our tools. Please spend some time learning the workings of git if you aren’t well-versed in using it.

Below are the details of your tasks. It mainly involves downloading, testing and using the tools.

2.1. pygetpapers

  • Read the official documentation
  • Install the tool
  • Run a query to download a hundred papers related to “invasive plant species” in XML and PDF - format
  • Document your steps coherently

2.2. pyami

3. Intern’s documentation

On an Etherpad TODO: Build an etherpad template.