From 724b813666cdd256baea0b243eb0f7a4d4bd0524 Mon Sep 17 00:00:00 2001 From: 3urobeat <35304405+3urobeat@users.noreply.github.com> Date: Tue, 26 Mar 2024 16:54:17 +0100 Subject: [PATCH] docs: Improve contributing page and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 12 +++---- .github/ISSUE_TEMPLATE/feature_request.md | 4 +-- .../ISSUE_TEMPLATE/help-wanted-question.md | 4 +-- docs/wiki/contributing.md | 31 ++++++++++++------- src/data/fileStructure.json | 8 ++--- 5 files changed, 33 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 51193322..f7904293 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,17 +1,17 @@ --- -name: Bug report -about: Report an error/a problem you experienced +name: Bug Report +about: Report an error or problem you've experienced title: '' labels: Bug assignees: '' --- -**Describe the bug** +**Please describe the bug** What happened? -**Full error** -Please post the **complete** error here! +**Full error stack trace** +If you've got an error, please post the **entire** error stack trace here! **Additional context** -Please add any other information here if you have some. +Please add any other information here, if you have some. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0de37c24..30b33bd9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Feature request +name: Feature Request about: Suggest a feature idea title: '' labels: Enhancement @@ -11,4 +11,4 @@ assignees: '' A clear description of what should happen. **Additional context** -Add any other context or screenshots about the feature request here. +Please add any other information here, if you have some. diff --git a/.github/ISSUE_TEMPLATE/help-wanted-question.md b/.github/ISSUE_TEMPLATE/help-wanted-question.md index cd272ede..3593dce4 100644 --- a/.github/ISSUE_TEMPLATE/help-wanted-question.md +++ b/.github/ISSUE_TEMPLATE/help-wanted-question.md @@ -1,5 +1,5 @@ --- -name: Help wanted/Question +name: I need help about: I have a question/need help but a Q&A discussion isn't fitting title: '' labels: Question @@ -11,4 +11,4 @@ assignees: '' Please explain your question here. If you've got an error or something else related, then please include it here as well. **Additional information** -Please add any other information here if you have some. +Please add any other information here, if you have some. diff --git a/docs/wiki/contributing.md b/docs/wiki/contributing.md index 94794833..9eac0633 100644 --- a/docs/wiki/contributing.md +++ b/docs/wiki/contributing.md @@ -15,16 +15,16 @@ Please read this page *before* diving in, it contains a few **very** important p ## Table Of Contents - [Reporting an issue](#reporting-an-issue) - [How to fork and open pull requests](#how-to-fork-and-open-pull-requests) -- [Translating](#translating) -- [Styling Guidelines](#styling-guidelines) +- [Updating or Adding a language translation](#translating) +- [Styling guidelines](#styling-guidelines) - [Starting the bot](#starting-the-bot)   ## Reporting an Issue -Found a bug? -Please report it by creating an [issue](https://github.com/3urobeat/steam-comment-service-bot/issues/new/choose) so that I am able to fix it! -If you've got a feature request instead, you can choose the "Feature request" template instead. +Found a bug/error? +Please report it by creating an [issue](https://github.com/3urobeat/steam-comment-service-bot/issues/new/choose). I'll respond as soon as possible. +If you've got a feature request instead, you can choose the "Feature request" template. If you have any questions, please open a [Q&A discussion](https://github.com/3urobeat/steam-comment-service-bot/discussions/new?category=q-a) instead! @@ -35,8 +35,10 @@ To contribute code to the project, you first need to fork this repository. Go to Before clicking the "Create fork" button in the next menu, make sure the checkmark at "Copy the `master` branch only" is **unchecked**! After waiting a few seconds you should now have a *copy* of the repository on your account. -Go into a folder on your computer where the project should be stored, open a terminal and run the command -`git clone https://github.com/your-username/steam-comment-service-bot` or use any other Git Client of your choice. +Assuming you already have `git` installed on your computer, open a folder on your PC where the project should be stored. +Open a terminal in this location and run the command +`git clone https://github.com/your-username/steam-comment-service-bot` +...or use any other Git Client of your choice. Once the repository has been cloned, switch to the `beta-testing` branch using the command `git checkout beta-testing`. This branch contains the latest changes and must be the one you base your changes off of. The `master` branch contains the latest release. @@ -44,20 +46,26 @@ This branch contains the latest changes and must be the one you base your change You can now create your own branch using `git checkout -b "branchname"`, make changes and commit them to it. It makes sense to give the branch a sensible name based on what your changes will be, but no pressure. -The setup of your dev bot is very similar to the [normal setup](./setup_guide.md), however make sure to run `npm install` manually. This will install all dev dependencies, which are omitted in the normal installation. +The setup of your dev bot is very similar to the [normal setup](./setup_guide.md), however make sure to run the command `npm install` in your terminal manually. +This will install all dev dependencies, which are omitted in the normal installation to save space. It is probably also a good idea to enable `printDebug` in `advancedconfig.json` to see a more detailed log output. -Once you have made your changes and verified they are working as expected, you need to open a Pull Request to merge them into this repository. +Make sure you have read '[Starting the bot](#starting-the-bot)' at the bottom of the page, before starting the bot to test your changes. + +Once you have made your changes and verified they are working as expected, you need to open a Pull Request to get them merged into this repository. [Click here](https://github.com/3urobeat/steam-comment-service-bot/compare/), click on "Compare across forks" at the top and select `base: beta-testing` on the left side. Then, choose your fork on the right at `head repository:`, your branch at `compare:` and click on "Create Pull Request". Give your pull request a fitting title which describes your changes in a few words and put a more in depth explanation below in the description. Once you are satisfied, hit the "Create pull request" button below to submit. I'll take a look at it and perhaps suggest or make some minor changes in the following few days. +Once everything looks good, I will merge your changes and they will be included in the next version.   ## Translating +The bot includes more translations than languages I speak myself - so I need your help here! + **Updating an existing language:** I'm changing or adding new messages nearly every update, so there are often language strings that need to be updated. It'd be great if you could help! @@ -122,9 +130,8 @@ In short, the main styling rules are:   ## Starting the bot -When starting the bot during development, it is crucial to execute the [generateFileStructure](/scripts/generateFileStructure.js) script before starting the bot, on every change. -You can do this easily by using a simple chained command: -`node scripts/generateFileStructure.js && node start.js` +When starting the bot during development, it is crucial to update every file's checksum, on every change. +You can do this easily by starting the bot using the command: `npm run dev` This ensures that [fileStructure.json](/src/data/fileStructure.json), which contains checksums for every file, gets updated. The application will otherwise recognize your changed file as broken and will restore it with the default one. diff --git a/src/data/fileStructure.json b/src/data/fileStructure.json index 4e4e80d3..5f2d74ef 100644 --- a/src/data/fileStructure.json +++ b/src/data/fileStructure.json @@ -13,17 +13,17 @@ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/.github/ISSUE_TEMPLATE/bug_report.md", - "checksum": "324472c36f99a41a0eb39f6875e11a56" + "checksum": "0427a2bb62d2775fbf47795461d343b5" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/.github/ISSUE_TEMPLATE/feature_request.md", - "checksum": "434308eeb7670ecc4fa63908eb6f9f56" + "checksum": "23a660d1130154f12b20168de15e264b" }, { "path": ".github/ISSUE_TEMPLATE/help-wanted-question.md", "url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/.github/ISSUE_TEMPLATE/help-wanted-question.md", - "checksum": "d341d7c8a2428d5c4a495508d5400b7d" + "checksum": "081c0421394521c2fafe5c518f2023a2" }, { "path": ".github/workflows/codeql-analysis.yml", @@ -243,7 +243,7 @@ { "path": "docs/wiki/contributing.md", "url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/docs/wiki/contributing.md", - "checksum": "7719bb31fc5180a04362a5d71e93f9bf" + "checksum": "bf2726a14d91675dd6b530da720aabab" }, { "path": "docs/wiki/creating_plugins.md",