Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1.26 KB
Raw

Contributing

Issues

To report an issue, please create a new issue on GitHub.

It's usually helpful to include any details that might be relevant to reproducing the issue (the code that causes it, the environment [Node, browser, etc], and the version of nba.js you're working with).

Feature Requests

To make a feature request, open an issue on GitHub.

Code Contributions

All contributions are welcome and appreciated, make sure the tests pass and the linter is happy. 😄

  • You'll need to fork & clone the repository to start with development.

    • Clone

      git clone https://github.com/{your_username}/nba.js
cd nba.js

    • Install dependencies

      npm install

  • To build (transpile) the source:

    npm run build # use build:watch to watch for changes in src/

  • To run tests:

    npm run test

  • For bugfixes and new features, it'd be appreciated if you added some sort of regression tests (if applicable).

  • Code style is enforced by ESLint with the Standard guide for JavaScript code. To run the linter:

    npm run lint