Contributing to LoopBack

Contributions to LoopBack include code, documentation, answering user questions, and advocating for all types of LoopBack users. See our official documentation on loopback.io for more information common to all of our GitHub repositories:

https://loopback.io/doc/en/contrib/index.html

Principles

LoopBack is an open, inclusive, and tolerant community of people working together to build a world-class Node framework and tools. We value diversity of individuals and opinions, and seek to operate on consensus whenever possible. We strive to maintain a welcoming, inclusive, and harassment-free environment, regardless of the form of communication. When consensus is not achievable, we defer to the owners of each individual module; the powers of the individual owner are kept in check by the ability of the community to fork and replace dependencies on the individual module and maintainer.

The LoopBack project adopts the Contributor Covenant version 2.

Reporting issues

Issues in loopbackio/loopback-next are the primary means by which bug reports and general discussions are made.

How to report an issue
Disclosing security vulnerabilities

Contributing code

Pull Requests are the way concrete changes are made to the code, documentation and tools contained in LoopBack repositories.

Monorepo overview
Setting up development environment
- Developing with VisualStudio Code (recommended)
- Developing with WebStorm
How to contribute the code
Building the project
Running tests
Coding rules
API documentation
Git commit messages
Making breaking changes
Reviewing pull requests
Developer Certificate of Origin (DCO)

Documentation

LoopBack documentation is sourced in both the loopbackio/loopback.io and loopbackio/loopback-next GitHub repositories. The loopback-next repository holds the documentation for LoopBack 4.

How LoopBack documentation works
Using Jekyll
Authoring pages
Translations

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!