aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-10-31 10:36:25 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-10-31 10:36:25 -0500
commit8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8 (patch)
tree0d8a1772a4579a136ebfdd06a3d368b3a2c0d1cf /CONTRIBUTING.md
parentci: Alter version bump to only ignore pnpm lockfile, not rest (diff)
downloadlocusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.tar
locusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.tar.gz
locusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.tar.bz2
locusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.tar.lz
locusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.tar.xz
locusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.tar.zst
locusts-8d1d5ca1cab59ead9085bf00f4ee5214bf10bfe8.zip
js: Migrate to ESLint 9
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 42fe3cd..5b96221 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
# 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.
+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
@@ -12,24 +12,30 @@ The main ways to can contribute are:
### 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:
+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 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:
+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 **MUST** include a GitHub Actions pipeline to build, run tests, and potentially publish the library to the library location.
+- The language **MUST** have some way of publishing and consuming libraries (ie.
+ a package manager).
+- Your PR **MUST** 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:
+- 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