1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[6284],{6264:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=n(1527),r=n(4128);const o={sidebar_position:2},i="Just before you start",a={id:"joinus/new-rss/before-start",title:"Just before you start",description:"In this tutorial, we will walk you through the process of creating an RSS feed for GitHub Repo Issues as an example.",source:"@site/docs/joinus/new-rss/before-start.md",sourceDirName:"joinus/new-rss",slug:"/joinus/new-rss/before-start",permalink:"/joinus/new-rss/before-start",draft:!1,unlisted:!1,editUrl:"https://github.com/DIYgod/RSSHub/blob/master/website/docs/joinus/new-rss/before-start.md",tags:[],version:"current",lastUpdatedBy:"DIYgod",lastUpdatedAt:1709995121,formattedLastUpdatedAt:"Mar 9, 2024",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"joinusSidebar",previous:{title:"Prerequisites",permalink:"/joinus/new-rss/prerequisites"},next:{title:"Create Route",permalink:"/joinus/new-rss/start-code"}},d={},l=[{value:"Install dependencies",id:"install-dependencies",level:2},{value:"Start debugging",id:"start-debugging",level:2},{value:"Follow the Script Standard",id:"follow-the-script-standard",level:2}];function u(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"just-before-you-start",children:"Just before you start"}),"\n",(0,s.jsxs)(t.p,{children:["In this tutorial, we will walk you through the process of creating an RSS feed for ",(0,s.jsx)(t.a,{href:"/routes/programming#github-repo-issues",children:"GitHub Repo Issues"})," as an example."]}),"\n",(0,s.jsx)(t.h2,{id:"install-dependencies",children:"Install dependencies"}),"\n",(0,s.jsx)(t.p,{children:"Before you start, you need to install the dependencies for RSSHub. You can do this by running the following command in the root directory of RSSHub:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-bash",children:"pnpm i\n"})}),"\n",(0,s.jsx)(t.h2,{id:"start-debugging",children:"Start debugging"}),"\n",(0,s.jsx)(t.p,{children:"Once you have successfully installed the dependencies, you can start debugging RSSHub by running the following command:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-bash",children:"pnpm dev\n"})}),"\n",(0,s.jsx)(t.p,{children:"Make sure to keep an eye on the console output for any error messages or other useful information that can help you diagnose and resolve issues. Additionally, don't hesitate to consult the RSSHub documentation or seek help from the community if you encounter any difficulties."}),"\n",(0,s.jsxs)(t.p,{children:["To view the result of your changes, open ",(0,s.jsx)(t.code,{children:"http://localhost:1200"})," in your browser. You'll be able to see the changes you made to the code automatically reflected in the browser."]}),"\n",(0,s.jsx)(t.h2,{id:"follow-the-script-standard",children:"Follow the Script Standard"}),"\n",(0,s.jsxs)(t.p,{children:["It's important to ensure that all new RSS routes adhere to the ",(0,s.jsx)(t.a,{href:"/joinus/advanced/script-standard",children:"Script Standard"}),". Failure to comply with this standard may result in your Pull Request not being merged in a reasonable timeframe."]}),"\n",(0,s.jsxs)(t.p,{children:["The ",(0,s.jsx)(t.a,{href:"/joinus/advanced/script-standard",children:"Script Standard"})," provides guidelines for creating high-quality and reliable source code. By following these guidelines, you can ensure that your RSS feed works as intended and is easy for other community maintainers to read."]}),"\n",(0,s.jsxs)(t.p,{children:["Before submitting your Pull Request, make sure to carefully review the ",(0,s.jsx)(t.a,{href:"/joinus/advanced/script-standard",children:"Script Standard"})," and ensure that your code meets all of the requirements. This will help to expedite the review process."]})]})}function c(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}}
1,4128:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var s=n(959);const r={},o=s.createContext(r);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.