Skip to content
This repository was archived by the owner on Jul 13, 2021. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (48 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.83 KB
Raw

Contributing

We are open to, and grateful for, any contributions made by the community. By contributing to Sequel.js, you agree to abide by the code of conduct.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Development

Visit the issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/orm.git

Building

Running the build task will compile your TypeScript files into JavaScript.

npm run build

Testing and Linting

To run the tests:

npm run test:coverage

To continuously watch and run tests, run the following:

npm run test:watch

New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

Submitting Changes

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the main branch.
  • Make sure all tests pass and there are no linting errors.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!

Attribution

This Contributing Guide is adapted from the React Redux Contributing Guide.