Skip to content
This repository was archived by the owner on Jul 16, 2025. It is now read-only.

Commit 8def867

Browse files
committed
Adding instructions on README
1 parent 9bff349 commit 8def867

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ WIP
4444

4545
# Development
4646

47+
## Requirements
48+
49+
To start, most of this package is a normal Python package. The main different thing is the static analysis tool that uses both git submodules and c code
50+
51+
Before installing, one should pull the submodules with
52+
53+
```
54+
git submodule update --init
55+
```
56+
57+
The c code shouldn't require anything on most places, but it might ask you to install compilers and stuff. Most of the times you can find the instructions online given the error messsage
58+
59+
## Guidelines
60+
4761
There are a few guidelines when developing in this systems. We have a few notable folders:
4862

4963
1. `commands` - It's the folder that interacts with the caller. This is where the commands themselves should live. They are not meant to do heavy lifting. They only do wiring, which is mostly parsing the input parameters

codecov_cli/services/staticanalysis/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import asyncio
22
import json
33
import logging
4+
import typing
45
from functools import partial
56
from multiprocessing import Pool
67
from pathlib import Path
@@ -9,7 +10,6 @@
910
import httpx
1011
import requests
1112
import yaml
12-
import typing
1313

1414
from codecov_cli.services.staticanalysis.analyzers import get_best_analyzer
1515
from codecov_cli.services.staticanalysis.exceptions import AnalysisError

0 commit comments

Comments
 (0)