Standard SDK
SKL Docs
  • Introduction
  • Get Started
    • Quick Start
    • Getting Started With SKL
  • Reference
    • API Reference
  • Other
    • Contributing
    • License
Powered by GitBook
On this page
  • Pull Requests
  • Writing Code
  • Testing
Edit on GitHub
  1. Other

Contributing

PreviousAPI ReferenceNextLicense

Last updated 1 year ago

Thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Standard SDK JS, which is hosted in the Comake Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Please read our to keep our community approachable and respectable.

To get an overview of the project, read the .

The repository is available at

Pull Requests

All changes should be done through .

We recommend first searching for existing related to your problem. If one does not exist, create a new to discuss a possible solution to reduce the amount of changes that will be requested.

After coming to consensus with maintainers, create a of the repo and implement your code changes and test.

In case any of your changes are breaking, make sure you target the next major branch (versions/x.0.0) instead of the main branch. Breaking changes include: changing interface/class signatures, potentially breaking external custom configurations, and breaking how internal data is stored. In case of doubt you probably want to target the next major branch.

Writing Code

Standard SDK JS is fully written in .

We make use of .

We use to enforce strict requirements from the and the before a PR is valid. These are configured to run automatically when trying to commit to git.

If a list of entries is alphabetically sorted, such as , make sure it stays that way.

Testing

To run tests manually, use:

npm run test

or to only run tests in a specific file, use:

npm run test ./test/unit/path/to/test.ts

As mentioned above, tests run automatically when trying to commit to git. You should add or update for any code that you add or change. If you are building a feature, please also add relevant

Code of Conduct
README
https://github.com/comake/standard-sdk-js
Pull Requests
Issues
Issue
Fork
Typescript
Conventional Commits
Husky
linter
test coverage
index.ts
unit tests
integration tests