Giter Club home page Giter Club logo

coworker-tools's Introduction

Coworker Discovery Tools

CodeYourFuture JS2 Module Project

Setup

Clone the repo to your local computer and open it in VSCode:

git clone https://github.com/IwonaKrysp/coworker-tools.git
cd coworker-tools
code .

Contributing

For each task you should create a pull request (PR). To do this you should follow these steps:

From the command line:

  1. Make sure you are on the main branch git checkout main
  2. Make sure your main branch is up-to-date git pull
  3. Create a new branch for your work git checkout -b branch-name
  4. Commit your work
  5. Push your branch to GitHub git push -u

In GitHub:

  1. In GitHub go to https://github.com/IwonaKrysp/coworker-tools/pulls
  2. You should find a button to create a new pull request for your branch
  3. Include a clear title and description to explain your work
  4. In the description, reference the issue you are working e.g. #4 if the issue number is 4
  5. Create the pull request
  6. Ask a fellow student or mentor to review your work
  7. Move the issue card to the Review/QA column
  8. Once the reviewer has approved your PR you can merge the branch by clicking the merge button
  9. Finally, move the issue to the Done column ๐ŸŽ‰

coworker-tools's People

Contributors

cyf-uma[bot] avatar iwonakrysp avatar

Watchers

 avatar

coworker-tools's Issues

Introducing your technical lead

Hi @IwonaKrysp!

About me

I am the virtual technical lead for this project. In robot years, I've been a developer for nearly a decade now. Every year I make fresh mistakes, but with each mistake I learn what pitfalls to avoid โ€“ and am here to help you avoid them!

Working together

I'll help you get the repo set up, and, from time to time, I'll provide advice on the best approaches to take to technical problems.

Next steps

  1. Close this issue to complete this onboarding step

  2. Find the pull request I have opened. It has some boilerplate code and setup instructions. Review the code and once you're happy merge the PR.

Introducing your product owner

Hi @IwonaKrysp!

About me

I am the virtual product owner for this project. My job is to understand users' needs so that we can build a product that really helps people.

How do I do this? By talking to users and stakeholders to find out what problems they need solved, and to learn about how people are currently solving their problems.

From these discussions I create user stories, which describe how particular users will be able to solve their problems once the work is done.

What I don't do is describe how a something should be built โ€“ I leave that to the designers and developers. My job is all about people!

Working together

To keep track of our progress, I've created a project board where I will add tasks and users stories. (You can find it by going to the projects tab).

We'll talk about the project board more once the rest of the team have joined the project.

Next steps

To mark the current step as done just close this issue. You can then return to the CYF Learning Lab to complete your next onboarding step.

Set up repo (Uma)

Uma, once you're invited to the project, can you take this on?

We just need the repo set up with the structure you want @IwonaKrysp to follow so we can get started on the tasks.

Acceptance criteria:

  • @IwonaKrysp can start on the first tasks
  • There are clear instructions on how to contribute to the repo
  • There are clear instructions on how to run the code

Store member data for use in digital tools

Problem

At the moment people data within the organisation is not stored in a well-organised way and members of the organisation do not have access to it. This makes it hard for members to do things like:

  • Find how who their colleagues are
  • Work out who to go to for help with particular problems
  • See who else is working in their region

User Story

  1. As a member of the organisation, I would like to see member data in one place.

  2. As a developer, I would like to be able to access member data in order to build digital tools.

Acceptance Criteria

  1. The data should be stored in a JavaScript array/object
  2. The data should be store in a logical format

Attachments

I'm still waiting for complete data from HR but they've given me this sample dataset which you can use for the time being. We can update it later.

first name ,last name ,job title         ,department  ,manager  ,location  ,first aider ,user slack ,timezone
John       ,Doe       ,Software Engineer ,Engineering ,null     ,Glasgow   ,No          ,johndoe    ,America/Los_Angeles
Jane       ,Doe       ,Software Engineer ,Engineering ,John Doe ,Leeds     ,No          ,janedoe    ,America/Los_Angeles
Bob        ,Doe       ,Software Engineer ,Engineering ,Jane Doe ,Cape Town ,No          ,bobdoe     ,America/Los_Angeles
Sally      ,Doe       ,Software Engineer ,Engineering ,Jane Doe ,Rome      ,No          ,sallydoe   ,America/Los_Angeles

Create CLI command to list members

Problem

We need to provide a way for members to access the member data we have stored.

For our initial MVP let's create a CLI (command line interface) tool that lets users pull this data up in a terminal (old school!).

User Story

As a member, I would like to view a list of all members in the organisation

Acceptance Criteria

  1. Users can run a command from the command line and see a list of all members
  2. The output is displayed in a humnan-readable format that can be quickly digested
  3. Only key information is displayed

Introducing your scrum master

Hi @IwonaKrysp!

About me

As scrum master, I help the team to achieve their project goals and resolve any blockers. I do this by promoting the processes and princple of the scrum framework.

Although I'm the one keeping an eye on the board's progress, each team member is still responsible for keeping it up-to-date.

Working together

Every week we take some of the project cards that Malachi has created to work on.

I use the project board (which you find listed in https://github.com/IwonaKrysp/coworker-tools/projects) to see how the project is progressing. It's a great place for getting an overview and moving cards between columns.

You can also find a more detailed view of the cards here, in the issues section.

Next steps

  1. Close this issue to complete this onboarding step

  2. Find the highest priority task in the project board (we place the most important tasks at the top), and, if it hasn't already been picked up, assign it your self.

  3. Once you have assigned the card to yourself, drag it to the In Progress column.

  4. Read the description carefully and use Uma's advice in the comment to complete the task.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.