Added contributing section

This commit is contained in:
Erik C. Thauvin 2024-01-31 18:11:21 -08:00
parent 7a0245d986
commit 78d0eef8b3

View file

@ -127,7 +127,7 @@ try {
}
```
```
```console
Status Code: 400
Error: Sorry, the URL you entered is on our internal blacklist. It may have been used abusively in the past, or it may link to another URL redirection service.
```
@ -139,3 +139,22 @@ Additionally, link can be shortened using [v.gd](https://v.gd/) by setting the `
```kotlin
Isgd.shorten("https://www.example.com/", isVgd = true) // returns https://v.gd/2z2ncj
```
## Contributing
If you want to contribute to this project, all you have to do is clone the GitHub
repository:
```console
git clone git@github.com:ethauvin/isgd-shorten.git
```
Then use [bld](https://rife2.com/bld) to build:
```console
cd isgd-shorten
./bld compile
```
The project has an [IntelliJ IDEA](https://www.jetbrains.com/idea/) project structure. You can just open it after all
the dependencies were downloaded and peruse the code.