Skip to content
This repository was archived by the owner on Jan 18, 2026. It is now read-only.

Commit 6b99e6a

Browse files
author
Erazem Kokot
committed
Update contributing guide
1 parent 20946bf commit 6b99e6a

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,22 @@ should be in `lower_case`
1717
* Explain what arguments a function takes (if any)
1818
* Use different error codes when exiting and explain when they occur
1919
at the top of the file
20-
* If you've created a new file or made big changes (judge this by yourself),
21-
you can add a copyright disclaimer below the shebang and any other copyright
22-
notices (e.g. `Copyright (C) Jane Doe <contact@jane.doe>`)
23-
* Use the `log` function if necessary
20+
* If you've created a new file or have made a lot of changes
21+
(judge this by yourself), you can add a copyright disclaimer below the shebang
22+
line and below any other copyright notices
23+
(e.g. `Copyright (C) Jane Doe <contact@jane.doe>`)
2424
* Always line wrap at 80 characters
25-
* Scripts are named `setup-*` (without a `.sh` extension)
26-
* Libraries (`lib` directory) should always have a `.sh` suffix and NO shebang
27-
* Neither script nor libraries should be executable (their permissions are
25+
* Scripts should be named `setup-<function>` and should not have an extension
26+
* Libraries should always have a `.sh` extension and should not have a shebang
27+
* Neither scripts nor libraries should be executable (their permissions are
2828
set during compilation)
29-
* Use shellscript to error-check your code
30-
* Test your code before submitting a PR (unless it's a draft)
29+
* Use `shellscript` to error-check your code
30+
* Test your code before submitting a PR (not required if it's a draft)
31+
* Write long and informative commit messages
3132

3233
## Translating (updating existing translations)
3334

34-
Anarchy Linux supports a bunch of languages, most of which need maintainers.
35+
Anarchy supports multiple languages, most of which need maintainers.
3536

3637
* Make sure to use the UTF-8 encoding
3738
* Don't change the variable names (e.g. `intro_msg=`)
@@ -45,7 +46,7 @@ at the top of the file (example below)
4546

4647
```
4748
# Maintainer: John Doe <contact@john.doe>
48-
# Maintainer: Jane Doe <contact@jane.doe>
49+
# Current Maintainer: Jane Doe <contact@jane.doe>
4950
```
5051

5152
_Comparing language files to one another makes Anarchy more consistent
@@ -57,5 +58,5 @@ and easier to update in the future._
5758
(check english.conf for size comparison - ~500 translations)
5859
* Copy the `english.conf` file and rename it to your language's
5960
english name (e.g. `portuguese.conf` or `spanish.conf`)
60-
* Change the LANG variable to your language's UTF-8 locale (e.g. `sl_SI.UTF-8`)
61-
* Read above recommendations
61+
* Update the LANG variable to your language's UTF-8 locale (e.g. `sl_SI.UTF-8`)
62+
* Read the previous recommendations for existing Anarchy translations

0 commit comments

Comments
 (0)