Skip to content

Commit 3f048d0

Browse files
committed
chore: add contributing guide
1 parent 9f5ee3b commit 3f048d0

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Welcome!
2+
3+
Welcome to the Axolotl language files, first off, thank you for taking the time to consider contributing!
4+
All contributions are extremely helpful and greatly appreciated!
5+
6+
This document contains a set of guides for contributing to this project.
7+
8+
<details>
9+
<summary>Table of Contents</summary>
10+
11+
<!-- TOC -->
12+
* [Welcome!](#welcome)
13+
* [Code of Conduct](#code-of-conduct)
14+
* [Questions](#questions)
15+
* [Contributing](#contributing)
16+
* [Submitting issues](#submitting-issues)
17+
* [Translating a message](#translating-a-message)
18+
* [Translating to a new language](#translating-to-a-new-language)
19+
<!-- TOC -->
20+
</details>
21+
22+
# Code of Conduct
23+
24+
Please help keep this project open and inclusive for all.
25+
Read and follow the [Code of Conduct](https://github.com/HyperaDev/.github/blob/main/CODE_OF_CONDUCT.md) before
26+
contributing to this repository.
27+
28+
If you have encountered someone who is not following the Code of Conduct, please report them
29+
30+
31+
# Questions
32+
33+
> **Please do not use GitHub issues to ask questions.** You will get a faster response if you ask on Discord!
34+
35+
If you wish to ask a question, please contact us using Discord by joining
36+
the [Hypera Development Discord server](https://discord.hypera.dev/), and you will get a response as soon as
37+
someone is next available.
38+
39+
# Contributing
40+
41+
There are many ways to contribute to `hypera.dev/lib`, and they all help!
42+
Here are the most common types of contributions:
43+
44+
* [Submitting issues](#submitting-issues)
45+
* [Security vulnerabilities](#security-vulnerabilities)
46+
* [Suggesting features](#suggesting-features)
47+
* [Code contributions](#code-contributions)
48+
* [Supporting the authors](#supporting-the-authors)
49+
50+
## Submitting issues
51+
52+
If you have found a typo, grammatical issue, missing translation, or another issue, you can help us
53+
by [creating an issue](https://github.com/HyperaDev/axolotl-lang/issues/new)!
54+
55+
If you have the time and required knowledge, you can
56+
also [create a pull request](https://github.com/HyperaDev/axolotl-lang/compare) to resolve the issue!
57+
58+
## Translating a message
59+
60+
If you have found a message that has not been translated to an already supported locale that you can translate, you can
61+
help us greatly by [create a pull request](https://github.com/HyperaDev/axolotl-lang/compare) to translate the message!
62+
63+
## Translating to a new language
64+
65+
Do you know a language that we don't currently support? You can help us greatly by contributing a new translation file
66+
for the language! If you only have the time to translate some of the messages, that is okay! Having some translations is
67+
a lot better than none.
68+
69+
Please note that we are only able to support locales also supported by Discord.
70+
You can see all locales supported by Discord at https://discord.com/developers/docs/reference#locales.
71+
72+
To translate to a new language:
73+
- Create a file in [`locales`](locales) for the language, using the BCP 47 language tag.
74+
- Translate messages from [`locales/en-GB.toml`](locales/en-GB.toml) (or the language file that you can understand).
75+
- Add the locale to `supportedLocales` in [`lang.go`](lang.go) (You can see all options
76+
in [discordgo](https://github.com/bwmarrin/discordgo/blob/master/locales.go))
77+
- [Create a pull request](https://github.com/HyperaDev/axolotl-lang/compare) to contribute them to this repository!
78+
79+
80+
Thank you to everyone who has contributed! :D

0 commit comments

Comments
 (0)