-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Contributing to Simple Icons CDN | ||
|
||
## Ways you can help | ||
|
||
### Financial contributions | ||
|
||
- [GitHub Sponsor](https://github.com/sponsors/LitoMore) | ||
- [PayPal](https://paypal.me/LitoMore) | ||
|
||
## Coding guidelines | ||
|
||
### Deno | ||
|
||
This project written in Deno. You can get Deno from [deno.com](https://deno.com). | ||
We usually use the latest version of Deno for development, so please feel free to install the latest version. | ||
|
||
### Tests | ||
|
||
When adding or changing features please write tests. We're using Deno's built-in [`Deno.test()`](https://docs.deno.com/runtime/fundamentals/testing/) utilities for testing. | ||
|
||
You can use `deno test` to run unit tests. And use `deno task test` to test all code formats, linting, types, and unit tests. | ||
|
||
### Coverage | ||
|
||
We require code coverage to be 100% all the time. You can use `deno task test --html` to generate a coverage report in HTML. | ||
|
||
### Development | ||
|
||
Use `deno task dev` to start a development server, watching for changes and running on a specific port. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,6 +12,7 @@ | |
"exclude": [ | ||
".vscode", | ||
"coverage", | ||
"CONTRIBUTING.md", | ||
"README.md" | ||
] | ||
}, | ||
|