-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Adds xspace and cspace to utils (conversion and space checking utilities) - Various odd bug fixes, such as undefined argument checks. - Testing via Jest - Code coverage via Coveralls - CI/CD with Travis
- Loading branch information
Showing
16 changed files
with
6,979 additions
and
516 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 |
---|---|---|
@@ -1,2 +1,3 @@ | ||
test.js | ||
node_modules | ||
node_modules | ||
coverage |
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 @@ | ||
coverage |
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 @@ | ||
{} |
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,12 @@ | ||
sudo: false | ||
language: node_js | ||
node_js: | ||
- 14 | ||
- 12 | ||
- 10 | ||
|
||
jobs: | ||
include: | ||
- stage: Generate Coverage | ||
node_js: "node" | ||
script: npm run coverage |
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,77 @@ | ||
# Contributing | ||
|
||
Jump in the pit and add something new! | ||
|
||
## Getting Started | ||
|
||
1. Fork Prismaek and run | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
2. On your fork, create a new branch named: | ||
|
||
``` | ||
username/work-description | ||
``` | ||
|
||
- Where **username** is your GitHub username and **work-description** is a short description of your contribution. | ||
|
||
For example: `mster/support-CMYK` | ||
|
||
3. Complete your contribution and commit your work to the branch you created. | ||
|
||
4. When you're ready for review or to submit your contribution, double check a few things. | ||
|
||
- ✓ First, make sure your fork is up to date. If your fork is out of date, you will need to rebase. | ||
|
||
- ✓ Next, assure that your code pases all tests. | ||
``` | ||
npm test | ||
``` | ||
See [Testing](#testing) for more information. | ||
|
||
5. If your contribution is more than a single commit, squash all commits into one. Provide a brief description of your work inside the commit message. | ||
|
||
6. Open a pull request to `main` and request review from user `@mster`. | ||
|
||
7. Make any changes suggested during review. | ||
|
||
8. You will be added to the list of contributors and have your code merged. | ||
|
||
## Features | ||
|
||
Have an feature in mind? Go for it -- if we like it, we will add it. You can always open a "Work in Progress" pull request. | ||
|
||
Follow the [Getting Started](#getting-started) guide if you're new to this. | ||
|
||
## Code Style | ||
|
||
Prismaek uses [Prettier](https://prettier.io/). To have your contributions accepted, they must also be in this style. | ||
|
||
To test if your code passes, run the test command: | ||
|
||
``` | ||
npm run lint | ||
``` | ||
|
||
To auto-fix any linting issues, use the command: | ||
|
||
``` | ||
npm run lint-fix | ||
``` | ||
|
||
## Testing | ||
|
||
Prismaek uses [Jest](https://jestjs.io/) as our testing framework. To run these tests use the command: | ||
|
||
``` | ||
npm run jest | ||
``` | ||
|
||
## Need Help? | ||
|
||
We're happy to help out, no matter how small the issue. | ||
|
||
Open an issue, ping the author (@mster), or join the Discord. |
Oops, something went wrong.