Skip to content

Commit c250983

Browse files
committed
add: contributing guide
Closes #1
1 parent 172dace commit c250983

4 files changed

Lines changed: 64 additions & 0 deletions

File tree

docs/CONTRIBUTING-WIKI.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to the Wiki
2+
3+
The content of the wiki articles is stored in `src/content/wiki` in [MDX](https://mdxjs.com/) files. MDX allows us to use components in Markdown.
4+
5+
The various components available for use can be found in [`src/components/common`](../src/components/common/) and [`src/components/wiki`](../src/components/wiki/). Make sure to check out their `README` files to learn more about the components.
6+
7+
## Article Frontmatter
8+
9+
All wiki articles can contain frontmatter at the top of the file.
10+
11+
| Property | Type | Required | Descripion |
12+
| :-------------: | :--------: | :------: | --------------------------------------------------------------------------------------------------------------------------- |
13+
| title | `string` || Display title of the article. |
14+
| description | `string` || Short summary of the article. |
15+
| tags | `string[]` || Keywords used in the site search to match this article. |
16+
| getting-started | `boolean` || Whether or not the article should appear in the "Get Started" section on the wiki index. |
17+
| incomplete | `boolean` || Mark this article as unfinished. A [`Remark`](../src/components/common/Remark.astro) will appear at the top of the article. |
18+
19+
```mdx
20+
---
21+
title: myArticleTitle
22+
description: Wow, my own article, cool!
23+
incomplete: true
24+
---
25+
```

docs/CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing Guide
2+
3+
Hello! Thank you for taking an interest in helping us improve! This document serves to help you learn how to contribute to the project.
4+
5+
See ["Contributing to the Wiki"](./CONTRIBUTING-WIKI.md).
6+
7+
# Contribution Types
8+
9+
We appreciate all contributions, whether you want to add a feature, add documentation to the wiki, fix a typo, or just get involved in the conversation in [issues](https://github/LuaLS/website/issues) and [discussions](https://github.com/LuaLS/website/discussions).
10+
11+
Here are some great ways to get involved:
12+
13+
- Create an issue
14+
- Report unexpected behaviour with the site.
15+
- Report old, confusing, or incorrect documentation.
16+
17+
- Create a discussion
18+
- Chat about more general topics that aren't really an "issue".
19+
- Share your ideas.
20+
21+
- Assist with existing issues
22+
- Find [issues needing help](https://github.com/LuaLS/website/labels/help%20wanted) and [issues for new contributors](https://github.com/LuaLS/website/contribute).
23+
24+
- Create a pull request
25+
- Quickly fix typos and bad links.
26+
- [Add content to the wiki](./CONTRIBUTING-WIKI.md)
27+
28+
> **Note**
29+
> If you are unsure which medium is best for expressing your idea or concern, start with an issue.

src/components/layout/Footer.astro

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ const { class: className } = Astro.props;
2222
<li>
2323
<a href="/wiki/developing">Development guide</a>
2424
</li>
25+
<li>
26+
<ExternalLink url="https://github.com/LuaLS/website/blob/main/docs/CONTRIBUTING.md">Wiki</ExternalLink>
27+
</li>
2528
<li>
2629
<a href="/wiki/translations#contributing">Translate</a>
2730
</li>

src/pages/wiki/index.astro

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import Icon from "~/components/common/Icon.astro";
44
import Layout from "~/layouts/Main.astro";
55
import Tooltip from "~/components/common/Tooltip.astro";
66
import fetch from "~/util/fetch";
7+
import ExternalLink from "~/components/common/ExternalLink.astro";
78
89
const CONTRIBUTOR_COUNT = 30;
910
@@ -81,6 +82,12 @@ const contributors = (await response.json()) as Contributor[];
8182
group="solid"
8283
color="red"
8384
/>
85+
<br />
86+
<ExternalLink
87+
url="https://github.com/LuaLS/website/blob/main/docs/CONTRIBUTING.md"
88+
>
89+
Contribute today!
90+
</ExternalLink>
8491
</p>
8592
<div class="flex">
8693
{

0 commit comments

Comments
 (0)