From a472f7394dcd64ae9780fa13a352bcac75d89b13 Mon Sep 17 00:00:00 2001 From: matya <78-Matya@users.noreply.octoforge.fr> Date: Mon, 30 Sep 2024 19:01:50 +0200 Subject: [PATCH] doc: Replace dev branch by main --- docs/CONTRIBUTING.md | 12 ++++++------ docs/DEPLOYMENT.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 97c6149..80d4e72 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -148,15 +148,15 @@ feature/send_pub_key ### Submitting Changes -1. Create a new branch based on the `dev` branch (TODO: Update for `main` branch). +1. Create a new branch based on the `main` branch. 2. Write your code. 3. Ensure you activated the virtual environment and activated the Python `pre-commit` hooks. A `pre-commit` hook should run before each commit. Commit your changes following the [commit message format](#commit-message-format). -4. **Pull from Upstream**: Before pushing your changes, pull the latest changes from the `upstream` dev branch: +4. **Pull from Upstream**: Before pushing your changes, pull the latest changes from the `upstream` main branch: ```sh -git pull upstream dev +git pull upstream main ``` 5. Push your work. @@ -181,7 +181,7 @@ $ poetry shell ### Writing documentation pages -1\. Create a new branch based on the `dev` branch (TODO: Update for `main` branch). It will be named as follows: `docs/<your_changes>` +1\. Create a new branch based on the `main` branch. It will be named as follows: `docs/<your_changes>` 2\. The documentation is created using [`MkDocs`](https://www.mkdocs.org). Thus, the documentation pages are Markdown files placed in the `docs` directory. Modify, delete or add any Markdown file you want. @@ -195,10 +195,10 @@ Then, open up `http://127.0.0.1:8000/` in your browser. 5\. Commit your changes. -6\. **Pull from Upstream**: Before pushing your changes, pull the latest changes from the `upstream` dev branch (TODO: Update for `main` branch): +6\. **Pull from Upstream**: Before pushing your changes, pull the latest changes from the `upstream` main branch: ```sh -$ git pull upstream dev +$ git pull upstream main ``` 7\. Push your work. diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 632b0b1..87af03c 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -43,7 +43,7 @@ And the following files: - `requirements.txt` - `babel.cfg` -Ensure the code is up-to-date and the current branch is the `dev` branch (TODO: Update for `main` branch). +Ensure the code is up-to-date and the current branch is the `main` branch. 3\. You must run the following commands as **root** on the Raspberry Pi. -- GitLab