Giter Club home page Giter Club logo

cgds_repo_template's Introduction

CGDS Repository Template [:pencil2: Edit this title]

Perform linting - Markdown

✏️ Add description of the project here.

Requirements

✏️ What are the requirements to install and run the project.

How to install

✏️ Add installation instructions here.

How to run

✏️ Add run instructions here. This includes necessary configurations as well as the commands used.

Repo's directory structure

The directory structure below shows the nature of files/directories used in this repo.

$ tree -a cgds_repo_template/
cgds_repo_template
├── CHANGELOG.md      <- Log of changes made
│
├── CONTRIBUTING.md   <- Contribution guidelines
│
├── LICENSE.md        <- License for the repo
│
├── README.md
│
├── .gitignore        <- Specifies intentionally untracked files to ignore by git
│
├── .editorconfig     <- Helps maintain consistent coding styles for multiple users working on the same project across
│                        various editors and IDEs. See https://editorconfig.org/ for more info
│
├── .markdownlint.json  <- Markdown linting config
│
├── .pylintrc         <- Python linting config
│
├── configs           <- Dir to store config files. Conda env, requirements.txt, etc.
│
├── data              <- Dir structure from http://drivendata.github.io/cookiecutter-data-science. Please give it a read.
│   ├── external      <- Data from third party sources
│   ├── interim       <- Intermediate data that has been transformed
│   ├── processed     <- The final, canonical datasets and results
│   └── raw           <- The original, immutable data dump
│
├── docs              <- Dir to store documentation.
│
├── notebooks         <- Dir to store Jupyter, R Markdown notebooks, etc.
│
├── src               <- Dir to store source code for use in this project
│
├── .github
│   ├── ISSUE_TEMPLATE            <- Github issue templates
│   │   ├── bug_report.md
│   │   └── feature_request.md
│   ├── PULL_REQUEST_TEMPLATE     <- Github PR templates
│   │   └── pull_request_template.md
│   └── workflows                 <- Github actions workflows for automated processes (eg. linting, etc)
│       └── linting.yml
│
├── .test             <- Dir to store test datasets
│   └── README.md
│
└── logs              <- Dir to store log files

Contributing

We welcome contributions! See the docs for guidelines.

cgds_repo_template's People

Contributors

manavalang avatar

Stargazers

 avatar Brandon M Wilk avatar

Watchers

Angelina Uno-Antonison avatar Liz Worthey avatar

cgds_repo_template's Issues

Add R linting config

As R is widely used across the team, we need to add linting for R. Tasks:

  1. Which linter to use?
  2. What configs to use?

Reached out to the team over slack to get info.

Add a test directory

Is your feature request related to a problem? Please describe.
No. While inspecting several other repos I noticed some have a .test or test directory at the root of the repo where unit, integration, and system tests and supporting mock data are generally stored. I thought it'd be a good addition to the template foir those projects with tests.

Describe the solution you'd like
Add a default .test or test directory to the root of the repo.

Describe alternatives you've considered
anything to indicate where tests and their associated setup should go in the repo

Additional context
none

Add github actions

  • Python linting - Lint configs added so far; see #4 for gh actions
  • Mardkown linting - Lint configs added so far.
  • Shell linting? - #11
  • R linting? - #12

What else?

Add emojis 😉

Emojis could make the template more inviting and user friendly. Don't overdo though 🥳

PR template doesn't pop up in PR

Describe the bug
Pull request template doesn't pop up when opening new PR.

To Reproduce
Create new branch, make changes, and open new PR in github

Expected behavior
Pull request template pops up in PR

Screenshots
NA

Environment used
NA

Additional context
Add any other context about the problem here.
None

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.