Skip to content

Commit b8b830f

Browse files
author
benoit-cty
committed
Spell check
1 parent 5a9e387 commit b8b830f

1 file changed

Lines changed: 9 additions & 34 deletions

File tree

docs/contributing/CONTRIBUTING.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- [Some UV commands](#some-uv-commands)
1515
- [Tests](#tests)
1616
- [Stress your computer](#stress-your-computer)
17-
- [Update all dependancies](#update-all-dependancies)
17+
- [Update all dependencies](#update-all-dependencies)
1818
- [Branching and Pull Requests](#branching-and-pull-requests)
1919
- [Debug in VS Code](#debug-in-vs-code)
2020
- [Coding style \&\& Linting](#coding-style--linting)
@@ -59,7 +59,7 @@ New issues can be created within the [GitHub repo](https://github.com/mlco2/code
5959
<!-- TOC --><a name="alternative-ways-of-contributing"></a>
6060
## Alternative ways of contributing
6161

62-
You have a cool idea, but do not know know if it fits with Code Carbon? You can create an issue to share:
62+
You have a cool idea, but do not know if it fits with Code Carbon? You can create an issue to share:
6363

6464
- the code, via the Github repo or [Binder](https://mybinder.org/), to share executable notebooks
6565
- a webapp, using [Voilà](https://github.com/voila-dashboards/voila), [Dash](https://github.com/plotly/dash) or [Streamlit](https://github.com/streamlit/streamlit)
@@ -74,7 +74,7 @@ You have a cool idea, but do not know know if it fits with Code Carbon? You can
7474

7575
CodeCarbon is a Python package, to contribute to it, you need to have Python installed on your machine, natively or with [UV](https://github.com/astral-sh/uv).
7676

77-
Between April 2024 and July 2025 we use Hatch for managing development environment. Since August 2025 we use UV manages the environments, Python versions, and dependencies - it's a fast, reliable way to work with Python projects.
77+
Between April 2024 and July 2025 we used Hatch for managing development environment. Since August 2025 we use UV to manage the environments, Python versions, and dependencies - it's a fast, reliable way to work with Python projects.
7878

7979
We have dropped support of Python 3.6 since version 2.0.0 of CodeCarbon.
8080

@@ -150,16 +150,16 @@ To test CodeCarbon, it is useful to stress your computer to make it use its full
150150
- [GPU-burn](https://github.com/wilicc/gpu-burn) will load test the GPU for a configurable duration.
151151
- To test the CPU : `stress-ng --cpu 0 --cpu-method matrixprod --metrics-brief --rapl --perf -t 60s` See [our documentation](https://mlco2.github.io/codecarbon/test_on_scaleway.html) to install it.
152152
- To do useful computation while testing [Folding At Home](https://foldingathome.org/) is a good option.
153-
- [OCCT](https://www.ocbase.com/download) is a proprietary tool but free for non-commercial use and avaliable for Windows and Linux.
153+
- [OCCT](https://www.ocbase.com/download) is a proprietary tool but free for non-commercial use and available for Windows and Linux.
154154

155155
To monitor the power consumption of your computer while stressing it, you can use:
156156

157157
- `nvidia-smi` is a useful tool to see the metrics of the GPU and compare it with CodeCarbon.
158158
- [powerstat](https://github.com/ColinIanKing/powerstat) can be used to see the metrics of the CPU and compare it with CodeCarbon. It's available on major distribution, like Debian-based Linux distributions with `sudo apt install powerstat`. Run it with `sudo powerstat -a -R 1 60`.
159159

160160

161-
<!-- TOC --><a name="update-all-dependancies"></a>
162-
### Update all dependancies
161+
<!-- TOC --><a name="update-all-dependencies"></a>
162+
### Update all dependencies
163163

164164
For multiple requirement files:
165165
```sh
@@ -309,31 +309,6 @@ Push force
309309
git push --force-with-lease
310310
```
311311

312-
### Rebase your branch on master
313-
314-
Before creating a PR, please make sure to rebase your branch on master to avoid merge conflicts and make the review easier. You can do it with the following command:
315-
```sh
316-
# Be careful, this command will delete every local changes you have, make sure to commit or stash them before running it
317-
TARGET_BRANCH=master
318-
current_branch=$(git symbolic-ref --short HEAD)
319-
git switch $TARGET_BRANCH && git pull
320-
git switch $current_branch --force && git fetch origin $TARGET_BRANCH
321-
git rebase $TARGET_BRANCH
322-
```
323-
324-
In case of a conflict during a rebase, "incoming" refers to your branch, and "current" refers to master. This is because the commits from your branch are being applied to master, so they are incoming. In case of a merge, it's the opposite!
325-
326-
Check if everything is fine:
327-
328-
```sh
329-
git status
330-
```
331-
332-
Push force
333-
```sh
334-
git push --force-with-lease
335-
```
336-
337312
<!-- TOC --><a name="release-process"></a>
338313
### Release process
339314

@@ -518,7 +493,7 @@ CALL public.spcc_purgeduplicatedata();
518493
<!-- TOC --><a name="api-1"></a>
519494
#### API
520495

521-
The API is availiable to everyone from https://api.codecarbon.io, but if you want to deploy it for yourself, here are the instructions.
496+
The API is available to everyone from https://api.codecarbon.io, but if you want to deploy it for yourself, here are the instructions.
522497

523498
To deploy the API we use [Clever Cloud](https://www.clever-cloud.com/), an IT Automation platform. They manage all the hard ops work while we focus on the Code Carbon value.
524499

@@ -546,15 +521,15 @@ git push deploy master:master
546521

547522
Yeah, not so hard, is it?
548523

549-
See (the doc)[https://www.clever-cloud.com/doc/getting-started/quickstart/] for more informations.
524+
See [the doc](https://www.clever-cloud.com/doc/getting-started/quickstart/) for more informations.
550525

551526
Please note that Clever Cloud host Code Carbon for free because they like our project.
552527

553528

554529
<!-- TOC --><a name="dashboard"></a>
555530
#### Dashboard
556531

557-
Same as for the API, for example to deploy the branh `fix-unit` to CleverCloud:
532+
Same as for the API, for example to deploy the branch `fix-unit` to CleverCloud:
558533

559534
```sh
560535
git push clever-dashboard fix-unit:master

0 commit comments

Comments
 (0)