From a8237a27fd667566bf5aa26ca8d5826a3538475b Mon Sep 17 00:00:00 2001 From: Benjamin Sutas Date: Tue, 10 Sep 2024 00:46:35 +1000 Subject: [PATCH 1/5] Placeholder file --- models/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 models/.gitkeep diff --git a/models/.gitkeep b/models/.gitkeep new file mode 100644 index 0000000..e69de29 From bfde2852b8e2af122af819ebaeaef7fff7a8d4fd Mon Sep 17 00:00:00 2001 From: Benjamin Sutas Date: Tue, 10 Sep 2024 00:59:06 +1000 Subject: [PATCH 2/5] Update README.md Add `How to Contribute` mini guide --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 37e32cb..a98ff5a 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,25 @@ You can get in touch with us via the OpenLoco Discord server. There is a dedicat - Invitation link: https://discord.gg/Td2GPYqzpv - [![](https://img.shields.io/discord/689445672390361176?label=OpenLoco%2Fgraphics)](https://discordapp.com/channels/689445672390361176/1276903199885758535), +## How to Contribute (for non-technical users) +1. Install GitHub Desktop. +1. Fork OpenLoco/OpenGraphics to make a personal repository. + ![image](https://github.com/user-attachments/assets/6631275e-e7e7-444a-9850-fdd997adb5e8) +1. Clone your personal repository. + ![image](https://github.com/user-attachments/assets/6ed7c863-d6f1-48d6-948e-a1fd5dc1b746) +1. Make a new branch. + ![image](https://github.com/user-attachments/assets/2f834142-16c4-4de6-9684-b810207d070f) +1. Make your changes. They'll show up in GitHub Desktop + ![image](https://github.com/user-attachments/assets/1d0a8137-ea09-4232-88a2-615226cc55c4) +1. Add/commit your changes. + ![image](https://github.com/user-attachments/assets/8c08bf07-14ef-42b1-a2fb-bcae4421f96c) +1. Publish your branch + ![image](https://github.com/user-attachments/assets/9b60eaa0-8d2a-419a-8e16-7cfa222c86ad) +1. Open a pull request with OpenLoco/OpenGraphics. + ![image](https://github.com/user-attachments/assets/bad84247-b9db-4dd2-a7b8-ec5c7f3b4c43) +1. Someone will review the pull request. +1. If it passes review, it will be merged and you're done. If it doesn't you'll have to fix your changes, which is just repeating steps 5-7. + ## License **OpenGraphics** is licensed under the GNU General Public License version 3. From 33716212f66679b1cdb24df3e9ea79c9f329e6db Mon Sep 17 00:00:00 2001 From: Benjamin Sutas Date: Tue, 10 Sep 2024 01:01:27 +1000 Subject: [PATCH 3/5] Update README.md Fix formatting for contribution steps --- README.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a98ff5a..6b757cd 100644 --- a/README.md +++ b/README.md @@ -39,23 +39,40 @@ You can get in touch with us via the OpenLoco Discord server. There is a dedicat - [![](https://img.shields.io/discord/689445672390361176?label=OpenLoco%2Fgraphics)](https://discordapp.com/channels/689445672390361176/1276903199885758535), ## How to Contribute (for non-technical users) + +### GitHub Desktop + 1. Install GitHub Desktop. -1. Fork OpenLoco/OpenGraphics to make a personal repository. - ![image](https://github.com/user-attachments/assets/6631275e-e7e7-444a-9850-fdd997adb5e8) -1. Clone your personal repository. - ![image](https://github.com/user-attachments/assets/6ed7c863-d6f1-48d6-948e-a1fd5dc1b746) -1. Make a new branch. +2. Fork OpenLoco/OpenGraphics to make a personal repository. + +![image](https://github.com/user-attachments/assets/6631275e-e7e7-444a-9850-fdd997adb5e8) + +3. Clone your personal repository. + +![image](https://github.com/user-attachments/assets/6ed7c863-d6f1-48d6-948e-a1fd5dc1b746) + +4. Make a new branch. + ![image](https://github.com/user-attachments/assets/2f834142-16c4-4de6-9684-b810207d070f) -1. Make your changes. They'll show up in GitHub Desktop + +5. Make your changes. They'll show up in GitHub Desktop. + ![image](https://github.com/user-attachments/assets/1d0a8137-ea09-4232-88a2-615226cc55c4) -1. Add/commit your changes. + +6. Add/commit your changes. + ![image](https://github.com/user-attachments/assets/8c08bf07-14ef-42b1-a2fb-bcae4421f96c) -1. Publish your branch + +7. Publish your branch. + ![image](https://github.com/user-attachments/assets/9b60eaa0-8d2a-419a-8e16-7cfa222c86ad) -1. Open a pull request with OpenLoco/OpenGraphics. + +8. Open a pull request with OpenLoco/OpenGraphics. + ![image](https://github.com/user-attachments/assets/bad84247-b9db-4dd2-a7b8-ec5c7f3b4c43) -1. Someone will review the pull request. -1. If it passes review, it will be merged and you're done. If it doesn't you'll have to fix your changes, which is just repeating steps 5-7. + +9. Someone will review the pull request. +10. If it passes review, it will be merged and you're done. If it doesn't you'll have to fix your changes, which is just repeating steps 5-7. ## License From 84a9f871c92c314c757d39f2bdde1521f663939f Mon Sep 17 00:00:00 2001 From: Benjamin Sutas Date: Tue, 10 Sep 2024 01:06:03 +1000 Subject: [PATCH 4/5] Update README.md Add PR screenshot --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6b757cd..614ca5b 100644 --- a/README.md +++ b/README.md @@ -70,9 +70,14 @@ You can get in touch with us via the OpenLoco Discord server. There is a dedicat 8. Open a pull request with OpenLoco/OpenGraphics. ![image](https://github.com/user-attachments/assets/bad84247-b9db-4dd2-a7b8-ec5c7f3b4c43) + +9. It should look something like this in GitHub (online): + +![image](https://github.com/user-attachments/assets/8a6d03d5-f11c-48a3-ae84-6e429423372c) + -9. Someone will review the pull request. -10. If it passes review, it will be merged and you're done. If it doesn't you'll have to fix your changes, which is just repeating steps 5-7. +10. Someone will review the pull request. +11. If it passes review, it will be merged and you're done. If it doesn't you'll have to fix your changes, which is just repeating steps 5-7. ## License From 02d4e27b39716f3002e35e28867eb183e24360ab Mon Sep 17 00:00:00 2001 From: Benjamin Sutas Date: Tue, 10 Sep 2024 01:08:10 +1000 Subject: [PATCH 5/5] Update README.md Add 'make an account' --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 614ca5b..3269285 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,8 @@ You can get in touch with us via the OpenLoco Discord server. There is a dedicat ## How to Contribute (for non-technical users) +You will need a GitHub account to contribute to the repository in any manner. Please make one first if you haven't already. + ### GitHub Desktop 1. Install GitHub Desktop.