search

bcgov / SDD_PLMS

Apache License 2.0
0 stars 0 forks source link

readme

SDD_PLMS_Analytics

Introduction

This repository contains the data analytics components for PLMS. PLMS stands for Prevention and Loss Management Services, which is a branch under the Service Delivery Division (SDD) of the BC Ministry of Social Development and Poverty Reduction. The goal of this repo is to provide a platform for code maintenance and sharing among data analysts and scientists of the branch. The wiki page of this repo contains additional information.

Layout

At the highest level, the repo layout is divided into three main directories, which is a model of the branch's workflow at the highest level. Further information can be found on the wiki page. The three highest level directories are:

  • Ad hoc analysis

    These are requests for data analysis that are not due to an on going project, but arise from the needs of either the business or the executives. These requests could require quick or extensive analysis.

  • Projects

    These are analyses that are part of a projects. The project could be internal to data team, PLMS or external

  • Production

    Productions are scripts that are run to generate attributes, which are uploaded to the ICM for further actions by the QCS

Getting Started

  1. Create an account: If you don't already have a GitHub account, you'll need to create one. Go to github.com and sign up for a free account.

  2. Create a repository: Once you're signed in to GitHub, you can create a new repository by clicking on the "+" icon in the top-right corner of the screen and selecting "New Repository". Give your repository a name and a description, and choose whether it should be public or private.

  3. Clone the repository: To work on your code locally, you'll need to clone the repository to your computer. You can do this by clicking on the green "Code" button in the top-right corner of the repository page and copying the URL.

bash git clonehttps://github.com/username/repo.git

  1. Make changes: Once you've cloned the repository, you can make changes to the code using your favorite code editor.

  2. Commit your changes: When you've made changes to your code, you'll need to commit them. This creates a snapshot of your code at a particular point in time. You can do this using the following command:

git add git commit-m "commit message"

  1. Push your changes: Once you've committed your changes, you'll need to push them to GitHub so that others can see them. You can do this using the following command:

git push

  1. Create a pull request: If you want to merge your changes into another branch (usually the main branch), you will need to create a pull request. Go to your repository on GitHub, click on the "Pull requests" tab, and click on the "New pull request" button. Follow the instructions to create a new pull request.

  2. Create a pull request for your code to be reviewed and merged into the main branch