From 4bcb5dd4e389fd82de02f8db9d2e088af687e339 Mon Sep 17 00:00:00 2001 From: fullonic Date: Wed, 14 Oct 2020 12:33:08 +0200 Subject: [PATCH 1/3] Improve documentation about pre-commit --- .github/pull_request_template.md | 4 ++-- CONTRIBUTING.md | 11 ++++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2576c434..5d4ee718 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ Explain the details for making this change. What existing problem does the pull The code has to be well formatted following the formatting rules. For example in Python the code has to follow the PEP8. -Before create your PR, please make sure your code is formatted running: +Before create your PR, please make sure your code is well formatted and styled doing: ```bash -$ >> black --exclude=venv,__pycache__ ./ +$ >> pre-commit run --all ``` \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0c2c56a..afd8bd5d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,10 @@ There are many ways in which you can contribute, beyond writing code. The goal o ## How to contribute -1. Fork this very repository (use the `fork` button at the top left) +1. Fork this very repository (use the `fork` button at the top left). + +**Tip**: If you have permission, use the [GeeksCAT fork](https://github.com/GeeksCAT/anem-per-feina) directly instead of create a new fork. + 2. Clone the newly created fork (use the green `clone` button) > Remember to [configure your SSH key]() 3. Add this repository remote and name it `common`, use the follow command: @@ -40,10 +43,10 @@ git checkout common/master -b pre-commit run --all ``` -> **Tip:** Ensure you have `pre-commit` tool installed by doing `python -m pip -r requirements-test.txt` inside you virtual environment. +> **Tip:** Ensure you have `pre-commit` tool installed by doing `python -m pip -r requirements-test.txt` inside you virtual environment. (Optional) Doing `pre-commit install` in your local repo will ensure that `pre-commit run --all` command runs automatically on every commit. > **Note:** If there is any error or warning, please solve it before continue. -1. Push the committed changes to your fork (the `origin` remote) +9. Push the committed changes to your fork (the `origin` remote) ```bash git push origin HEAD @@ -128,5 +131,3 @@ please see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-C # Thank You! Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. - - From eb66b139f6bf88a052c20dcdcaa5d42059852137 Mon Sep 17 00:00:00 2001 From: fullonic Date: Wed, 14 Oct 2020 13:19:22 +0200 Subject: [PATCH 2/3] Improves "fork tip" on CONTRIBUTING file --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afd8bd5d..196ed4e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,11 @@ There are many ways in which you can contribute, beyond writing code. The goal o 1. Fork this very repository (use the `fork` button at the top left). -**Tip**: If you have permission, use the [GeeksCAT fork](https://github.com/GeeksCAT/anem-per-feina) directly instead of create a new fork. +**Tip for hacktoberfest'20 participants**: If you have doubts or troubles forking and keeping it synchronized, start a new branch from **master** and submit a PR directly in this [repo](https://github.com/GeeksCAT/anem-per-feina). -2. Clone the newly created fork (use the green `clone` button) +1. Clone the newly created fork (use the green `clone` button) > Remember to [configure your SSH key]() -3. Add this repository remote and name it `common`, use the follow command: +2. Add this repository remote and name it `common`, use the follow command: ```bash git remote add common git@github.com:GeeksCAT/anem-per-feina.git From f319f5ea8ec78850d946e86b46c2966f9a87d82f Mon Sep 17 00:00:00 2001 From: dbf <13336073+fullonic@users.noreply.github.com> Date: Wed, 14 Oct 2020 13:51:33 +0200 Subject: [PATCH 3/3] Update CONTRIBUTING.md Fix double space typo. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 196ed4e1..4405ceaf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ There are many ways in which you can contribute, beyond writing code. The goal o 1. Fork this very repository (use the `fork` button at the top left). -**Tip for hacktoberfest'20 participants**: If you have doubts or troubles forking and keeping it synchronized, start a new branch from **master** and submit a PR directly in this [repo](https://github.com/GeeksCAT/anem-per-feina). +**Tip for hacktoberfest'20 participants**: If you have doubts or troubles forking and keeping it synchronized, start a new branch from **master** and submit a PR directly in this [repo](https://github.com/GeeksCAT/anem-per-feina). 1. Clone the newly created fork (use the green `clone` button) > Remember to [configure your SSH key]()