From e1c3dc0151caf859a0c35f4bc66a1f5120051657 Mon Sep 17 00:00:00 2001 From: Matt Huson Date: Mon, 24 Oct 2022 23:34:42 -0400 Subject: [PATCH 1/3] test commit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f6a4c099e..a339d5669 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ as an administration guide available at or in the [docs repo](https://github.com/wger-project/docs). Please consult the commands' help for further information and available -parameters. +parameters... ### Production From 799f1117ce70e8ed5f0fa2847f7fa25093e812c7 Mon Sep 17 00:00:00 2001 From: Matt Huson Date: Wed, 26 Oct 2022 21:30:51 -0400 Subject: [PATCH 2/3] test --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a339d5669..b12a8660a 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ as an administration guide available at or in the [docs repo](https://github.com/wger-project/docs). Please consult the commands' help for further information and available -parameters... +parameters. ### Production @@ -79,6 +79,24 @@ file for details). You will also probably want to set `DJANGO_DEBUG to false If you prefer a local installation, consult the [development documentation](https://wger.readthedocs.io/en/latest/development.html) +#### Quick how to guide: Contributing to documentation using an editor (VScode) + +Step 1. Create GitHub account if you don't already have one. + +Step 2. CLone repository you wish to make changes to + +Step 3. Open in editor (VScode) + +Step 4. Make desired changes in editor + +Step 5. Save changes and stage changes + +Step 6. Commit to local repository + +Step 7. "Push" commit to remote repository + +Step 8. Log into GitHub, check commits are there. Done. + ## Contact From e1577cbc6dcfa6fefa11624b08cc8f6203fbcdda Mon Sep 17 00:00:00 2001 From: Matt Huson Date: Wed, 30 Nov 2022 20:57:31 -0500 Subject: [PATCH 3/3] contribution guide changes --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b12a8660a..433d24b40 100644 --- a/README.md +++ b/README.md @@ -79,23 +79,37 @@ file for details). You will also probably want to set `DJANGO_DEBUG to false If you prefer a local installation, consult the [development documentation](https://wger.readthedocs.io/en/latest/development.html) -#### Quick how to guide: Contributing to documentation using an editor (VScode) + +#### Beginner's guide to contributing to this project- See steps below with tips Step 1. Create GitHub account if you don't already have one. -Step 2. CLone repository you wish to make changes to +https://github.com/join + +Step 2. CLone repository you wish to make changes to. + +https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository + +Step 3. Open in editor of your choosing (example: VScode). -Step 3. Open in editor (VScode) +https://www.hostinger.com/tutorials/best-code-editors Step 4. Make desired changes in editor -Step 5. Save changes and stage changes +Step 5. Save changes and stage changes (see turorial below) + +https://www.youtube.com/watch?v=-dI00g5KdD4 + +Step 6. Commit to local repository and "Push" to remote repository(see turorial below). + +https://www.youtube.com/watch?v=B8RSMBSzFuA + +Step 7. Log into GitHub, check commits are there. -Step 6. Commit to local repository +Step 8. Create pull request to original repository on Github. -Step 7. "Push" commit to remote repository +https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request -Step 8. Log into GitHub, check commits are there. Done. ## Contact