diff options
| author | Matt Strapp <matt@mattstrapp.net> | 2024-08-06 15:56:58 -0500 |
|---|---|---|
| committer | Matt Strapp <matt@mattstrapp.net> | 2024-08-06 15:56:58 -0500 |
| commit | 3d272668c7c7003bcd1e1b8026d041d07acac150 (patch) | |
| tree | 4b4a9b1a11dadfc27714da370b73bafaa2105755 | |
| parent | Add docker (diff) | |
| download | locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.tar locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.tar.gz locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.tar.bz2 locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.tar.lz locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.tar.xz locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.tar.zst locusts-3d272668c7c7003bcd1e1b8026d041d07acac150.zip | |
Add a basic CONTRIBUTING and README
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to '')
| -rw-r--r-- | CONTRIBUTING.md | 36 | ||||
| -rw-r--r-- | README.md | 7 |
2 files changed, 41 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5ede9a5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing + +First off, thanks for taking the time to contribute! 🎉 +We welcome all sorts of contributions, from bug reports to feature requests to code contributions. + +## How to contribute + +The main ways to can contribute are: + +- [Requesting a new language](#requesting-a-new-language) +- [Adding a new language](#adding-a-new-language) + +### Requesting a new language + +If you'd like to request a new language to be added to the repository, please open an issue with the `new language` label. +Please include the following information: + +- The name of the language +- A brief description of the language +- The language's website, if any exist +- Any relevant documentation on how to build, test, and publish libraries in the language +- Any CI information +- Any other relevant information + +### Adding a new language + +If you'd like to add a new language to the repository, please follow these guidelines: + +- The language **MUST** have some way of publishing and consuming libraries (ie. a package manager). +- Your PR **SHOULD** (but doesn't have to) include a GitHub Actions pipeline to build, run tests, and potentially publish the library to the library location. + - See any of the existing language workflows for examples. +- Your PR **MUST** include a `LANGUAGE`.md file in the `docs` directory with the following information: + - A basic way to add the library as a dependency + - An example of how to use the library + - A link on the README.md to the new language documentation + @@ -10,8 +10,6 @@ The punchline of [XKCD 797](https://xkcd.com/797/). (Pictured below) [](https://xkcd.com/797/) -Including locusts as a dependency in your codebase is probably a terrible idea from a security standpoint, but it's very funny. - ### Why would you do this? It's funny. @@ -24,6 +22,11 @@ No. See the documentation below. +### Can I contribute? + +Yes! Please do! We welcome all contributions. +See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information. + ## Currently Supported Languages - [C/C++](./docs/C.md) |