From 5fffda25c1f0158bbf5a2e34701b9dbb83509a21 Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 08:55:16 +0200 Subject: [PATCH 1/9] Add upper case to tip --- docs/src/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/contributing.md b/docs/src/contributing.md index 6e41c9e5..45b992e8 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -18,7 +18,7 @@ If you found an issue that interests you, comment on that issue what your plans If the solution to the issue is clear, you can immediately create a pull request (see below). Otherwise, say what your proposed solution is and wait for a discussion around it. -> **tip** +> **Tip** > > Feel free to ping us after a few days if there are no responses. From 20c4d4366b93a9d7bd3c88bf93ec703abdb9fc65 Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 08:55:55 +0200 Subject: [PATCH 2/9] Fix typo in guideline --- docs/src/developer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index 09c990b3..4f818c9f 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -1,6 +1,6 @@ # Developer documentation -If you haven't, please read the [Contributing guidelindes](contributing.md) first. +If you haven't, please read the [Contributing guidelines](contributing.md) first. ## Linting and formatting From e2d44a956abcebe347733ac097157cad934692e7 Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 09:02:17 +0200 Subject: [PATCH 3/9] Update developer.md --- docs/src/developer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index 4f818c9f..53960700 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -10,7 +10,7 @@ This will ensure that your editor is configured with important formatting settin We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters. In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first. -Install `pre-commit` (we recommend using [pipx](https://pypa.github.io/pipx/)): +To install `pre-commit`, we recommend using [pipx](https://pypa.github.io/pipx/) as follows: ```bash # Install pipx following the link From ccdb81c69d085f8ae2eb235d49dc961f3790199e Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 09:07:34 +0200 Subject: [PATCH 4/9] Expand first time clone --- docs/src/developer.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index 53960700..bf8588d1 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -33,9 +33,14 @@ pre-commit run -a ## First time clone -1. Fork this repo -2. Clone your repo (this will create a `git remote` called `origin`) -3. Add this repo as a remote `git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl` +If this is the first time you work with this repository, follow the instructions below to clone the repository. + +1. Fork this repo. +2. Clone your repo (this will create a `git remote` called `origin`). +3. Add this repo as a remote. +```bash +git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl +``` ## Working on a new issue From 36172fad8ae9fe5ffed6af33c4a09b1c35b7a619 Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 09:10:58 +0200 Subject: [PATCH 5/9] Review commit mess section --- docs/src/developer.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index bf8588d1..e65c28f4 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -75,9 +75,9 @@ git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl ### Commit message -- Use imperative, present tense (Add feature, Fix bug) -- Have informative titles -- If necessary, add a body with details +- Use imperative or present tense, for instance: *Add feature* or *Fix bug*. +- Have informative titles. +- If necessary, add a body with details. ### Before creating a pull request From afc3a81195fe3fe90424e46af44660703b54607e Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 09:12:43 +0200 Subject: [PATCH 6/9] Update developer.md --- docs/src/developer.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index e65c28f4..7041e7a7 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -86,9 +86,9 @@ git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl - Make sure the pre-commit tests pass. - Fetch any `main` updates from upstream and rebase your branch, if necessary: - ```bash +```bash git fetch orgremote git rebase orgremote/main BRANCH_NAME - ``` +``` -- Then you can open a pull request and work with the reviewer to address any issues +- Then you can open a pull request and work with the reviewer to address any issues. From de9497777a58d0ec22cfda7033d698ce04e4d87c Mon Sep 17 00:00:00 2001 From: tmigot Date: Sun, 1 Oct 2023 09:15:04 +0200 Subject: [PATCH 7/9] Update developer.md --- docs/src/developer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index 7041e7a7..c7bc646c 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -37,7 +37,7 @@ If this is the first time you work with this repository, follow the instructions 1. Fork this repo. 2. Clone your repo (this will create a `git remote` called `origin`). -3. Add this repo as a remote. +3. Add this repo as a remote: ```bash git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl ``` From ecfa0da51d76a6d59e34e4c1bdaae927acf0a894 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Sun, 1 Oct 2023 12:16:57 +0200 Subject: [PATCH 8/9] Apply suggestions from code review --- docs/src/developer.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/src/developer.md b/docs/src/developer.md index c7bc646c..a463f3bb 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -38,9 +38,9 @@ If this is the first time you work with this repository, follow the instructions 1. Fork this repo. 2. Clone your repo (this will create a `git remote` called `origin`). 3. Add this repo as a remote: -```bash -git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl -``` + + ```bash + git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl ## Working on a new issue @@ -86,9 +86,8 @@ git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl - Make sure the pre-commit tests pass. - Fetch any `main` updates from upstream and rebase your branch, if necessary: -```bash + ```bash git fetch orgremote git rebase orgremote/main BRANCH_NAME -``` - Then you can open a pull request and work with the reviewer to address any issues. From ec9134aebd286b8e719f7ab2d11725ed50907193 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Mon, 2 Oct 2023 09:54:51 +0200 Subject: [PATCH 9/9] Apply changes to template instead of the package directly --- docs/src/contributing.md | 2 +- docs/src/developer.md | 24 ++++++++++-------------- template/docs/src/contributing.md.jinja | 2 +- template/docs/src/developer.md.jinja | 20 +++++++++++++------- 4 files changed, 25 insertions(+), 23 deletions(-) diff --git a/docs/src/contributing.md b/docs/src/contributing.md index 45b992e8..6e41c9e5 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -18,7 +18,7 @@ If you found an issue that interests you, comment on that issue what your plans If the solution to the issue is clear, you can immediately create a pull request (see below). Otherwise, say what your proposed solution is and wait for a discussion around it. -> **Tip** +> **tip** > > Feel free to ping us after a few days if there are no responses. diff --git a/docs/src/developer.md b/docs/src/developer.md index a463f3bb..09c990b3 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -1,6 +1,6 @@ # Developer documentation -If you haven't, please read the [Contributing guidelines](contributing.md) first. +If you haven't, please read the [Contributing guidelindes](contributing.md) first. ## Linting and formatting @@ -10,7 +10,7 @@ This will ensure that your editor is configured with important formatting settin We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters. In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first. -To install `pre-commit`, we recommend using [pipx](https://pypa.github.io/pipx/) as follows: +Install `pre-commit` (we recommend using [pipx](https://pypa.github.io/pipx/)): ```bash # Install pipx following the link @@ -33,14 +33,9 @@ pre-commit run -a ## First time clone -If this is the first time you work with this repository, follow the instructions below to clone the repository. - -1. Fork this repo. -2. Clone your repo (this will create a `git remote` called `origin`). -3. Add this repo as a remote: - - ```bash - git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl +1. Fork this repo +2. Clone your repo (this will create a `git remote` called `origin`) +3. Add this repo as a remote `git remote add orgremote https://github.com/abelsiqueira/COPIERTemplate.jl` ## Working on a new issue @@ -75,9 +70,9 @@ If this is the first time you work with this repository, follow the instructions ### Commit message -- Use imperative or present tense, for instance: *Add feature* or *Fix bug*. -- Have informative titles. -- If necessary, add a body with details. +- Use imperative, present tense (Add feature, Fix bug) +- Have informative titles +- If necessary, add a body with details ### Before creating a pull request @@ -89,5 +84,6 @@ If this is the first time you work with this repository, follow the instructions ```bash git fetch orgremote git rebase orgremote/main BRANCH_NAME + ``` -- Then you can open a pull request and work with the reviewer to address any issues. +- Then you can open a pull request and work with the reviewer to address any issues diff --git a/template/docs/src/contributing.md.jinja b/template/docs/src/contributing.md.jinja index af864172..d13a08e5 100644 --- a/template/docs/src/contributing.md.jinja +++ b/template/docs/src/contributing.md.jinja @@ -18,7 +18,7 @@ If you found an issue that interests you, comment on that issue what your plans If the solution to the issue is clear, you can immediately create a pull request (see below). Otherwise, say what your proposed solution is and wait for a discussion around it. -> **tip** +> **Tip** > > Feel free to ping us after a few days if there are no responses. diff --git a/template/docs/src/developer.md.jinja b/template/docs/src/developer.md.jinja index 7c4a99bf..e55361dd 100644 --- a/template/docs/src/developer.md.jinja +++ b/template/docs/src/developer.md.jinja @@ -1,6 +1,6 @@ # Developer documentation -If you haven't, please read the [Contributing guidelindes](contributing.md) first. +If you haven't, please read the [Contributing guidelines](contributing.md) first. ## Linting and formatting @@ -10,7 +10,7 @@ This will ensure that your editor is configured with important formatting settin We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters. In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first. -Install `pre-commit` (we recommend using [pipx](https://pypa.github.io/pipx/)): +To install `pre-commit`, we recommend using [pipx](https://pypa.github.io/pipx/) as follows: ```bash # Install pipx following the link @@ -33,9 +33,15 @@ pre-commit run -a ## First time clone +If this is the first time you work with this repository, follow the instructions below to clone the repository. + 1. Fork this repo 2. Clone your repo (this will create a `git remote` called `origin`) -3. Add this repo as a remote `git remote add orgremote https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl` +3. Add this repo as a remote: + + ```bash + git remote add orgremote https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl + ``` ## Working on a new issue @@ -70,9 +76,9 @@ pre-commit run -a ### Commit message -- Use imperative, present tense (Add feature, Fix bug) -- Have informative titles -- If necessary, add a body with details +- Use imperative or present tense, for instance: *Add feature* or *Fix bug*. +- Have informative titles. +- If necessary, add a body with details. ### Before creating a pull request @@ -86,4 +92,4 @@ pre-commit run -a git rebase orgremote/main BRANCH_NAME ``` -- Then you can open a pull request and work with the reviewer to address any issues +- Then you can open a pull request and work with the reviewer to address any issues.