https://elastos-wiki.netlify.app/assets/js/419a914f.09405884.js

1"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4031],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),u=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=u(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=u(n),d=r,h=c["".concat(l,".").concat(d)]||c[d]||m[d]||i;return n?a.createElement(h,o(o({ref:t},p),{},{components:n})):a.createElement(h,o({ref:t},p))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,o[1]=s;for(var u=2;u<i;u++)o[u]=n[u];return a.createElement.apply(null,o)}return a.createElement.apply(null,n)}d.displayName="MDXCreateElement"}

1,9193:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>u,toc:()=>c});var a=n(7462),r=n(3366),i=(n(7294),n(3905)),o=["components"],s={title:"Contributing"},l=void 0,u={unversionedId:"start/contributing",id:"start/contributing",title:"Contributing",description:"The wiki was started and is maintained by community contributors and product team leads. It is an open source project and aims",source:"@site/../docs/1.start/contributing.md",sourceDirName:"1.start",slug:"/start/contributing",permalink:"/start/contributing",draft:!1,editUrl:"https://github.com/elastos/Elastos.Wiki/edit/master/website/../docs/1.start/contributing.md",tags:[],version:"current",lastUpdatedBy:"racollette",lastUpdatedAt:1677304687,formattedLastUpdatedAt:"Feb 25, 2023",frontMatter:{title:"Contributing"},sidebar:"introductionSidebar",previous:{title:"Community",permalink:"/start/community"},next:{title:"Frequently Asked Questions (FAQs)",permalink:"/start/faq"}},p={},c=[{value:"How to Contribute",id:"how-to-contribute",level:2},{value:"The instant PR",id:"the-instant-pr",level:3},{value:"The typical PR",id:"the-typical-pr",level:3},{value:"Guideline and Rules for Contributing",id:"guideline-and-rules-for-contributing",level:2},{value:"Helping With Translations",id:"helping-with-translations",level:2}],m={toc:c},d="wrapper";function h(e){var t=e.components,n=(0,r.Z)(e,o);return(0,i.kt)(d,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"The wiki was started and is maintained by community contributors and product team leads. It is an open source project and aims\nto be the most extensive resource of knowledge on Elastos and the Elastos ecosystem. The majority of material currently focuses on Elastos directly but it is not opposed to including informational material for community projects and initiatives."),(0,i.kt)("admonition",{title:"Marketing material",type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Please do not try to pull request any marketing material as this will be rejected.")),(0,i.kt)("p",null,"Nonetheless, pull requests, discussions, and contributions from the community are encouraged. Active\ncommunity members who demonstrate a record of good contributions may be given write access to the\nrepository."),(0,i.kt)("p",null,"Otherwise, product leads hold the administrative position and final say on the content that is\nincluded."),(0,i.kt)("h2",{id:"how-to-contribute"},"How to Contribute"),(0,i.kt)("p",null,"You can contribute to the wiki on the\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/elastos/Elastos.Wiki"},"elastos/Elastos.Wiki ")," GitHub repository. Every page is a\n",(0,i.kt)("a",{parentName:"p",href:"https://guides.github.com/features/mastering-markdown/"},"MarkDown")," file, which is an easy to learn\nsyntax extension to plain text that makes creating links, rendering images, and nice-looking\nformatting simple."),(0,i.kt)("p",null,"Elastos uses ",(0,i.kt)("a",{parentName:"p",href:"https://docusaurus.io"},"Docusaurus")," for documentation. Please refer to their documentation for details on major structural contributions to the documentation."),(0,i.kt)("p",null,"For simple content changes you have 2 options"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://github.com/elastos/Elastos.Wiki/issues"},"Submit an issue")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://github.com/elastos/Elastos.Wiki/pulls"},"Submit a pull request")," ",(0,i.kt)("em",{parentName:"li"},"(we prefer PRs of course)"))),(0,i.kt)("h3",{id:"the-instant-pr"},"The instant PR"),(0,i.kt)("p",null,"This is the fastest way to submit content changes directly from the page where you notice a mistake."),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Open any page in the docs"),(0,i.kt)("li",{parentName:"ol"},"Click the ",(0,i.kt)("inlineCode",{parentName:"li"},"[ Edit ]")," button at the bottom left hand side of ",(0,i.kt)("em",{parentName:"li"},"every")," content page"),(0,i.kt)("li",{parentName:"ol"},"Make your edits to the document that opens in GitHub by clicking the \u270e (pencil) icon"),(0,i.kt)("li",{parentName:"ol"},"Submit a PR with your changes and comments for context")),(0,i.kt)("h3",{id:"the-typical-pr"},"The typical PR"),(0,i.kt)("p",null,"This is the standard fork-branch-commit workflow for submitting pull requests to open source repositories"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Fork this repo to your own GitHub account (or just clone it directly if you are currently a member of Elastos)")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Open your editor to the ",(0,i.kt)("em",{parentName:"p"},"top level repo folder")," to view the directory structure as seen below")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Move into the ",(0,i.kt)("inlineCode",{parentName:"p"},"/website")," folder where you will run the following commands:"),(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Make sure all the dependencies for the website are installed:"),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"# Install dependencies\nyarn\n"))),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},"Run the local docs development server"),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"# Start the site\nyarn start\n")),(0,i.kt)("p",{parentName:"li"},(0,i.kt)("em",{parentName:"p"},"Expected Output")),(0,i.kt)("pre",{parentName:"li"},(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"# Website with live reload is started\nLiveReload server started on port 35729\nDocusaurus server started on port 3000\n")),(0,i.kt)("p",{parentName:"li"},"The website for docs will open your browser locally to port ",(0,i.kt)("inlineCode",{parentName:"p"},"3000"))))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Make changes to the docs")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Observe those changes reflected in the local docs")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Submit a pull request with your changes"))),(0,i.kt)("h2",{id:"guideline-and-rules-for-contributing"},"Guideline and Rules for Contributing"),(0,i.kt)("p",null,"There are a few basic ground-rules for contributors:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("strong",{parentName:"li"},"No ",(0,i.kt)("inlineCode",{parentName:"strong"},"--force")," pushes")," or modifying the Git history in any way."),(0,i.kt)("li",{parentName:"ol"},"Pull requests are preferred to issues, especially for small changes such as typos. Issues should\nbe used for generic or broad-based changes or missing content. Suggestions and requests are encouraged."),(0,i.kt)("li",{parentName:"ol"},"Only use ",(0,i.kt)("strong",{parentName:"li"},"non-master branches"),"."),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("strong",{parentName:"li"},"Significant modifications"),", even by contributors, ought to be subject to a ",(0,i.kt)("strong",{parentName:"li"},"pull request")," to\nsolicit feedback from other contributors."),(0,i.kt)("li",{parentName:"ol"},"Pull requests to solicit feedback are ",(0,i.kt)("em",{parentName:"li"},"encouraged")," for any other non-trivial contribution but\nleft to the discretion of the contributor."),(0,i.kt)("li",{parentName:"ol"},"Contributors should attempt to adhere to the prevailing ",(0,i.kt)("inlineCode",{parentName:"li"}

1,"MarkDown")," style, language, and layout."),(0,i.kt)("li",{parentName:"ol"},"Correct grammar should be used at all times. Pull requests with typos will not be merged until\nfixed."),(0,i.kt)("li",{parentName:"ol"},"Care should be taken to remain as objective and informative as possible. There should be no\neditorializing, and external bias should not be present.")),(0,i.kt)("p",null,"This document is based on the\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/Level/community/blob/master/CONTRIBUTING.md"},"Level contribution guidelines"),"."),(0,i.kt)("hr",null),(0,i.kt)("h2",{id:"helping-with-translations"},"Helping With Translations"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Currently the Wiki is being populated and updated, during this time we will not be prioritizing translations.")),(0,i.kt)("p",null,"The Wiki's default language is ",(0,i.kt)("em",{parentName:"p"},"English"),", though, there is a desire to translate the Wiki\nin as many languages as possible. Another way you can contribute is by helping with translations."),(0,i.kt)("p",null,"Translation contributions can be made through ",(0,i.kt)("a",{parentName:"p",href:"https://crowdin.com/project/elastos-wiki"},"crowdin"),". There, you will see the progress of translating the docs associated with the Wiki in many different languages."))}h.isMDXComponent=!0}}]);