Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #37

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Create CONTRIBUTING.md #37

wants to merge 2 commits into from

Conversation

ahmetcetin
Copy link

closes #18

Copy link
Owner

@nanomosfet nanomosfet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contributing!
We should also note that the build should pass, could you add that in here?

could you add how to run tests / lint etc.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@nanomosfet
Copy link
Owner

I also need to check why the build is failing. it is related to node v13

requested changes

* Lint: npm run lint
* Test: npm run test
* Test coverage: npm run coveralls
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is actually used for CI

you can do:

Suggested change
* Test coverage: npm run coveralls
* Test coverage: npm test -- --coverage

or add script with "coverage" : "jest --coverage"

and make this

Suggested change
* Test coverage: npm run coveralls
* Test coverage: npm run coverage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create contributing.md
2 participants