docs: add contributing link from html docs back to github (#2145)

faker-js · May 11, 2023 · ca9610c · ca9610c
1 parent 9e1155c
commit ca9610c
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -44,6 +44,10 @@ function extendSideNav(current: SidebarItem): SidebarItem[] {
           text: 'Team',
           link: '/about/team',
         },
+        {
+          text: 'Contributing',
+          link: '/about/contributing',
+        },
       ],
     },
   ];
@@ -155,6 +159,10 @@ const config = defineConfig({
             text: 'Team',
             link: '/about/team',
           },
+          {
+            text: 'Contributing',
+            link: '/about/contributing',
+          },
         ],
       },
       {
@@ -230,6 +238,10 @@ const config = defineConfig({
             text: 'Team',
             link: '/about/team',
           },
+          {
+            text: 'Contributing',
+            link: '/about/contributing',
+          },
         ],
       }),
     },

diff --git a/docs/about/contributing.md b/docs/about/contributing.md
@@ -0,0 +1,7 @@
+---
+editLink: false
+---
+
+# Contributing
+
+We welcome new contributors! For more information see the [Contributing](https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md) file on Github. All contributors are expected to follow the [Code of Conduct](https://github.com/faker-js/faker/blob/next/CODE_OF_CONDUCT.md)