Development

Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens.

When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.

Recommended Reading:

• TypeScript (front-end/back-end)
• ReactJS (front-end, ui)
• MobX (app-state-management, back-end/front-end)
• ElectronJS (chrome/node)
• NodeJS (api docs)

Local Development Environment

Prerequisites for development and contribution:

• Nodejs v16 (with npm >= v8)
• git

Some scripts that are good to know about

• npm run dev - builds and starts the app
• npm run clean - cleanup local environment build artifacts

GitHub Workflow

We use the GitHub flow, so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below:

• Github Workflow

Code Testing

All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here:

• Contributor's Guide to Testing

License

By contributing, you agree that your contributions will be licensed as described in LICENSE.