diff --git a/astro.config.mjs b/astro.config.mjs index 41139d5e..76f6732f 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -470,6 +470,12 @@ export default defineConfig({ }, ], }, + { + label: "Request for help", + autogenerate: { + directory: "Request-for-help", + }, + }, ], }), ], diff --git a/package-lock.json b/package-lock.json index b78d2984..8e0a9e47 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4992,7 +4992,7 @@ "node_modules/prettier": { "version": "3.2.5", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", - "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==" "dev": true, "bin": { "prettier": "bin/prettier.cjs" @@ -6354,6 +6354,16 @@ "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", "dev": true + "node_modules/undici": { + "version": "5.23.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-5.23.0.tgz", + "integrity": "sha512-1D7w+fvRsqlQ9GscLBwcAJinqcZGHUKjbOmXdlE/v8BvEGXjeWAax+341q44EuTcHXXnfyKNbKRq4Lg7OzhMmg==", + "dependencies": { + "busboy": "^1.6.0" + }, + "engines": { + "node": ">=14.0" + } }, "node_modules/unherit": { "version": "3.0.1", @@ -10606,6 +10616,7 @@ "prettier": { "version": "3.2.5", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==" "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==", "dev": true }, diff --git a/src/content/docs/Request-for-help/How-to-request-for-help.md b/src/content/docs/Request-for-help/How-to-request-for-help.md new file mode 100644 index 00000000..abe2f47f --- /dev/null +++ b/src/content/docs/Request-for-help/How-to-request-for-help.md @@ -0,0 +1,87 @@ +--- +title: How to Request Help When Encountering an Issue +--- + +When you encounter an error during a task, it's essential to seek assistance promptly to minimize +delays and ensure smooth project progress. If you submit a request for help, it will be better to +provide clear and detailed information to streamline the troubleshooting process. Follow these steps +to submit a request for help on your team channel: + +## 1. Identify Your Team Channel + +Each project team has a dedicated channel for communication. For instance, if you're part of the +OnTrack Project Team, you should post your message on the OnTrack Channel. + +## 2. Craft Your Message + +Compose a message in the team channel that provides essential details about the issue you're facing. +Use the following standard format: + +**Content you need to provide:** + +- **Backlog:** + Provide the Backlog name and task name. + +- **Component:** + Specify the component or module you are working on. + +- **Repository:** + Include the link with problematic changes. + +- **Related Files:** + List the files you are working on or have modified, and include screenshots. + +- **Issue Description:** + Provide a concise description of the issue you are facing, and include a screenshot if applicable. + +- **Error Messages:** + Include any error messages or codes here, along with screenshots. + +- **Steps to Reproduce:** + List the steps you took that led to the issue, and include screenshots. + +- **What You Have Tried:** + Describe what you have attempted so far to resolve the issue, including any troubleshooting steps. + +- **Expected Outcome:** + Describe what you expected to happen. + +## 3. Example Message + +```markdown +Subject: Request for Assistance - Issue with [Task Name] + +Backlog: [Backlog Name and Task Name] Component: [Component/Module Name] Repository: [Link to +Repository with Problematic Changes] + +Related Files: + +- [File 1] +- [File 2] +- [Screenshot of Related Files] + +Issue Description: I encountered an issue while attempting to [describe the task]. Despite following +the outlined steps, [describe the problem briefly]. Please refer to the attached screenshot for more +clarity. + +Error Messages: + +- [Error Message 1] +- [Error Message 2] +- [Screenshot of Error Messages] + +Steps to Reproduce: + +1. [Step 1] +2. [Step 2] +3. [Step 3] [Include Screenshots of Steps] + +What You Have Tried: I have attempted the following: + +- [Troubleshooting Step 1] +- [Troubleshooting Step 2] + +Expected Outcome: [Describe what you expected to happen.] + +Any assistance in resolving this issue would be greatly appreciated. Thank you. +```