README.md

tools-shared

The shared tools for Lynx repositories

[Usage]

Install Habitat

We use Habitat to manage dependencies. Please install it first.

Pull the source code

You can download the code of tools-shared repository to your local machine via git clone or any other method.

Synchronize dependencies.

cd tools-shared
./hab sync -f .

Initialize the environment.

After this step, a sub-command "git lynx" will be added to the git tool.

source envsetup.sh

Run check

You can use the following commands to check if your last commit meets the pre-merge checks

git lynx check --help
git lynx check --list
git lynx check

Run format

If you have coding style issues, you can use the following commands to automatically format your code

git lynx format --help
git lynx format

Custom configuration

tools-shared has built-in default configurations. To meet your needs, you can manually provide a configuration file named tools-shared.yml in the root directory of the repository to override the default ones.

You can continue to check the detailed configuration information here.

Contributing Guide

We welcome you to join and become a member of Lynx Authors. It's people like you that make this project great.

Please refer to our contributing guide for details.

[License]

tools-shared is Apache licensed, as found in the LICENSE file.