Lisk - это блокчейн-проект с открытым исходным кодом. Когда бы вы ни работали над технологией блокчейн, безопасность всегда является приоритетом. А когда ваш проект имеет открытый исходный код, вы хотите максимально упростить для ваших разработчиков - будь то штатные сотрудники или часть более широкого сообщества - внесение хорошего кода.
Помня обе эти цели, мы всегда стремимся улучшить наши стандарты кода. Мы рады представить нашему сообществу наш репозиторий, посвященный улучшению и координации стандартов в экосистеме Lisk: Шаблон Lisk.
Координационные стандарты
Основная цель репозитория шаблонов Lisk - координировать принятие стандартов. Это состоит из:
- Каталог и файловая структура по умолчанию.
- Файл package.json по умолчанию, включая информацию о проекте, сценарии npm и основные зависимости, такие как наша конфигурация ESLint.
- Файлы конфигурации для различных инструментов, включая эти зависимости.
- Скелетная тестовая установка, готовая при желании приступить к работе с нашим пакетом Mocha BDD.
- Базовые файлы документации, включая нашу обычную предпочитаемую лицензию.
README.md для проекта предоставляет информацию о многих стандартах, собранных здесь.
Представленные здесь стандарты во многом основаны на практиках, которым мы следовали в различных проектах в экосистеме Lisk. Такие проекты, как Lisk Commander (ранее Lisky) и Lisk Elements (ранее Lisk JS) имеют меньшую кодовую базу, поэтому они часто играют роль полигона для тестирования новых стандартов кода или инструментов, которые мы рассматриваем для использования. Как только мы получим этот опыт и решим, что нам нравится такой стандарт, мы добавляем его в шаблон Lisk, и новый стандарт можно будет развернуть в других проектах Lisk по мере необходимости. (Неизбежно существуют специфические особенности проекта, которые могут означать, что данный стандарт не подходит для каждого проекта.)
Мы хотим стимулировать обсуждение стандартов и призываем всех, у кого есть идеи о том, как улучшить стандарты кода в Lisk или инструменты, которые мы должны использовать, открыть проблему в репозитории шаблонов Lisk.
Запуск новых проектов
Другой важный вариант использования Lisk Template - это запуск новых проектов. Поскольку репозиторий уже включает список зависимостей и конфигурации, это идеальный способ начать новый проект. Мы включили удобный скрипт, который поможет вам инициализировать новый проект. Полные инструкции можно найти здесь, но вы можете создать слегка настроенный скелет проекта, выполнив следующую команду с вашим именем пользователя GitHub и именем вашего нового проекта:
Мы уже использовали этот сценарий в Lisk HQ для создания репозитория Mocha BDD и будем использовать его для запуска новых проектов в будущем. (Вам, очевидно, придется заменить наши данные своими в информации о пакете, лицензии и т. Д.)
Вовлечены
В рамках миссии Lisk по обеспечению доступности технологии блокчейн для всех мы хотим максимально упростить разработчикам создание децентрализованных приложений. Это касается не только платформы, на которой построены эти приложения, но и инструментов, используемых при их создании.
Нам бы очень хотелось, чтобы члены нашего сообщества запускали новые проекты (связанные с Lisk или иначе!) с использованием сценария начальной загрузки шаблона Lisk. Любые отзывы, которые мы получим сейчас, будут неоценимы, когда они помогут людям в дальнейшем создавать сайдчейны.
А если у вас есть идеи о том, как улучшить стандарты Lisk, пожалуйста, откройте вопрос или примите участие в обсуждениях репозитория шаблонов Lisk.
Удачной начальной загрузки!
