vamchale/polyglot
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Contributing to Madlang

I emphatically welcome bug reports, issues you may encounter, documentation, and
pull requests. Feature requests will likely be implemented if and only they are
relatively small.

Do note that `polyglot` is hosted using
[pijul](https://nest.pijul.com/vamchale/polyglot), so contributions and bug
reports there will be more effective.

## Getting started

If you'd like ideas for ways to contribute, check out `TODO.md`. Feel free to
open a PR or an issue if you need guidance on how to implement something.

## Navigating the Code

ATS can be quite daunting. The following are things that are relatively easy to
implement:

  * Adding a new file type and its associated extension (note that the name of
    a file type must be less than 20 characters; otherwise there will be a type
    error!)
  * Adding a new directory to ignore (e.g. `.cabal-sandbox`)
  * Adding new shebang detection
  * Updating the `--help` or manpage.
  * Adding keywords to disambiguate extensions.

If you have any trouble figuring this out, feel free to open an issue and I will
give you guidance on where to look.

## Rules etc.
We follow the [rust standards of
conduct](https://www.rust-lang.org/en-US/conduct.html), with the addendum that
we are committed to providing a friendly, safe and welcoming environment
regardless of sex worker status or previous sex worker status.

In addition, please be aware that not everyone speaks English as a first
language.