Скачать - contributing - contributing исходного кода

contributing

Другой исходный код

1.0.0

Скачать

Способствуя Идеоксу

Введение

Прежде всего, команда разработчиков Ideoxan хотела бы лично поблагодарить вас за то, что вы нашли время, чтобы внести свой вклад в наш проект и сообщество!

Этот документ содержит всю необходимую информацию, чтобы внести свой вклад в идеоксанский проект. Если у вас есть какие -либо вопросы, свяжитесь с нами по адресу [email protected].

Кодекс поведения и лицензирования

Этот проект поддерживается и управляется в соответствии с официальным кодексом поведения проекта. Согласие с его условиями, наряду с официальными условиями обслуживания Идеоксана, Политика конфиденциальности Идеоксана и включенная лицензия (MIT) необходим для внесения вклад в проект этой организации.

Способствуя Идеоксу
- Введение
  - Кодекс поведения и лицензирования
  - Оглавление
- Настройка для внесения
  - Предварительные условия
    - Node.js
    - Git
    - ES6 поддерживающий браузер
    - Mongodb
  - Установка
    - Переменные среды
      - Mongodb uri
      - Экспресс -сессия секрет
      - Пароль хэш
    - Небольшая нота на учебной программе
    - Еще одна небольшая нота, но на этот раз на ветвях GIT
  - Бег
    - Режим разработчика
    - Нормальный SSU
    - Развертывание сервера
- Внесение вклад в проект
  - Сообщение о вопросах безопасности
  - Сообщение об ошибках или проблемах
    - Контрольный список ошибок
      - Это проблема относится к этому проекту?
      - Я вызвал проблему?
      - Я использую правильную версию необходимого программного обеспечения?
      - Об этой проблеме уже сообщалось?
      - Проблема связана с безопасностью?
    - Подача и проблема
  - Внесение в кодовую базу
  - Предложение и улучшение или функция
  - Обновление документации
  - Другой
- Стандарты и стиль
  - Стандарты
    - Документация
    - Выпуск/PR Метки
      - Ошибки
      - Проблема связана
      - Спецификация
      - Разное
- Связаться с нами

Настройка для внесения

Предварительные условия

Node.js

Среда выполнения Node.js требуется для запуска бэкэнд -сервера (что служит на веб -сайте). Версии выше 10.x поддерживаются. Предполагается, что использовать узел 13.x NPM также требуется, но обычно поставляется с Node.js. Вы можете проверить версию node.js, выполнив

node -v

Git

GIT CLI необходим для загрузки кода из репозитория.

ES6 поддерживающий браузер

Современный браузер, который поддерживает спецификации ES6 для JS, необходим для просмотра веб -сайта Chrome/Chromium, Firefox и Safari.

Mongodb

В то время как MongoDB не требуется на 100% для запуска веб -сайта, мы предлагаем вам установить его в любом случае, чтобы использовать логики и проверку пользователей. Чтобы установить MongoDB, см. Их руководство по документации. Убедитесь, что сервер работает на localhost или в другом месте, указанном в локальном списке или системных переменных среды

Установка

Используйте следующее, чтобы загрузить репозиторий и установить необходимые пакеты:

git clone https://github.com/ideoxan/ideoxan.git
cd ideoxan
npm install

Переменные среды

Сервер поддерживает использование как системных, так и локальных переменных среды. Если вы не можете установить общесистемную переменную среды, то создайте файл .env в основном идексанском каталоге. Убедитесь, что ваша среда узла не подходит для production иначе переменные среды не будут использоваться локально. Ниже приведен список использованных переменных среды. Если кто -либо из них противоречит, сообщите нам.

MONGO_URI
EXPRESS_SESSION_SECRET
PWD_HASH

Mongodb uri

Переменная среда MONGO_URI используется для установки URI базы данных MongoDB. Этот URI должен быть действительной строкой Mongouri. По умолчанию mongodb://localhost:27017/ix

Экспресс -сессия секрет

Переменная среда EXPRESS_SESSION_SECRET - это секрет, который будут использовать все сеансы, аутентифицированные с этим сервером. Лучше всего сохранять это безопасное и безопасное, так как это можно использовать для аннулирования, изменения и подделки (что не очень хорошо). Держите это как можно длинным и сложным. По умолчанию не существует по умолчанию.

Пароль хэш

Переменная среда PWD_HASH является целочисленным значением, которое используется для хэш -паролей в модуле BCRYPTJS. Держите номер достаточно высоко, где пароли безопасны, но достаточно низкие, чтобы он не заставляет сервер замедляться. Опять же, по соображениям безопасности нет значения по умолчанию.

Небольшая нота на учебной программе

Если вы хотите внести свой вклад в курс или урок, пожалуйста, посмотрите другие наши репозиции GitHub с префиксом curriculum- . Все наши руководства по учебным программам хранятся на GitHub (не все общедоступны) и хранятся сервер по /static/curriculum и запрашиваются стороной клиента в соответствии с статическим экспресс -каталогом ( /static ). Учебная программа не включена в редактор, веб -сайт или какое -либо содержание. При GIT эти курсы включены в качестве подмодулей и могут быть установлены в каталоге учебных программ с помощью следующего:

git submodule init
git submodule update --recursive

Это будет клонировать, привлекать и вытащить все общедоступные курсы. Если вы хотите узнать больше о подмодулях GIT и о том, как они работают, нажмите здесь.

Еще одна небольшая нота, но на этот раз на ветвях GIT

Есть две основные ветви, которые используются: master и prod . Филиал prod - это то, что отправляется для производства и развертывания. Мы стараемся обновлять эту ветвь только так часто, когда это необходимо (горячих вспомогательных аппаратов медленнее). master -филиал - это то, куда идет большинство наших новых коммитов. Думайте об этом как о свежей ночной системе сборки. Хотя в этом филиале есть новый код, это не означает, что он самый стабильный. Если вы планируете использовать это в долгосрочной перспективе и не хотите обновлять каждые 20 минут, мы предлагаем вам использовать ветвь prod .

Бег

Есть три варианта запуска сервера.

Режим разработчика

Режим разработчика - это команда для запуска сервера на машине разработки. Это позволяет легко редактировать и быстрое запуск сервера. Он полагается на пакет Nodemon, поэтому убедитесь, что зависимости разработчика, изложенные в файле package.json , установлены через NPM.

Чтобы запустить сервер локально использовать:

npm run dev

Нормальный SSU

Чтобы запустить сервер без дополнительных функций, запустите:

npm run start

Это автоматически обновляет любые включенные подмодули, а затем запускает сервер. В качестве альтернативы, сервер можно запустить так же, как и любой обычный проект Node.js:

node server.js

Развертывание сервера

Этот метод не используется, поскольку этот вариант лично адаптирован для конкретных серверов, используемых Ideoxan.

Это требует, чтобы PM2 был установлен во всем мире .

npm run server

Если это не работает, используется:

pm2 start server.js --name ideoxan --max-memory-restart 500M --watch --cron " 0 2 * * * "

Внесение вклад в проект

Сообщение о вопросах безопасности

Прежде всего, если вы считаете, что проблема, относящаяся к безопасности, не откройте проблему. Сообщите об ошибке напрямую нам по электронной почте

Проблема, которую вы сообщаете, обычно является проблемой безопасности, когда ...

Вы можете получить доступ, просмотреть, редактировать или каким -либо образом изменить что -то, что не ваше
Вы обнаружили что -то, что, скорее всего, не является работой Ideoxan, его партнеров, пакетов, участников, проверенных рекламодателей или сопровождающих на сайте, в репозитории кода или где -либо еще.
Вы обнаружили возможный способ злоупотребления API, сайтом или сервером
Ваша система была скомпрометирована из -за использования Идеоксана и его продукции

Если вы испытали какое -либо из вышеперечисленного, это, скорее всего, является результатом возможного риска безопасности и следует сообщать. Неспособность сообщать может привести к возможным судебным искам от нашего имени.

Даже если ваша проблема не соответствует вышеизложенному и все еще считает, что это проблема, связанная с безопасностью, не стесняйтесь по электронной почте. Лучше быть в безопасности, а не сожалеть.

Сообщение об ошибках или проблемах

Контрольный список ошибок

Пожалуйста, проверьте следующее, чтобы убедиться, что вы очистились, чтобы открыть проблему.

Это проблема относится к этому проекту?

Если ваша проблема связана со временем выполнения Node.js, любой из пакетов/программного обеспечения, который не покрывается/поддерживается Ideoxan, или чем -то еще, то это не подходящее место для подачи вашей проблемы. Если вам нужна помощь, направленную на правильный отслеживание ошибок или руководство по устранению неполадок, не стесняйтесь обращаться к нам. (См. Свяжитесь с нами)

Я вызвал проблему?

Если вы изменили какой -либо из источника, существует высокая вероятность того, что проблема была вызвана вмешательством. Если проблема все еще сохраняется после возвращения вашего кода, откройте проблему.

Я использую правильную версию необходимого программного обеспечения?

Мы не поддерживаем старое программное обеспечение. Пожалуйста package-lock.json проверьте свои версии в отношении тех, которые указаны в package.json master Branch.

Об этой проблеме уже сообщалось?

Если проблема уже сообщена, и она все еще открыта на нашем GitHub, пожалуйста, прокомментируйте свою проблему, а не открыть новую проблему. Если он все еще не открыт, проверьте его статус. Если в этом есть тег wont-fix , не поднимайте его снова, если вы не увидите его как выдающуюся проблему, и пройдет значительное количество времени. Также проверьте, есть ли решение. Иногда проблемы будут закрыты не потому, что они были помечены как недействительные или было достигнуто решение, а из -за отсутствия активности. Если вы обнаружите, что это так, не стесняйтесь запрашивать проблему, чтобы быть вновь открытым.

Проблема связана с безопасностью?

Если вы выпускаете, связаны с безопасностью, см. В вопросах безопасности отчетности.

Подача и проблема

Если вы следили за вышеуказанным и выполнили требования, теперь вы можете открыть проблему. Обязательно используйте описательное название и четко опишите вашу проблему. Обязательно следуйте шаблону отчета об ошибке (решительно предложено). Если вам не удастся правильно описать свою проблему, ваша проблема будет закрыта без объяснения.

Внесение в кодовую базу

Если вы участвуете в кодовой базе (не включает документацию), обязательно следуйте нашим стандартам.

Пожалуйста, проверьте, есть ли уже открытые проблемы, которые можно решить. Если нет, убедитесь, что запрос на притяжение еще не покрывает то, что вы пытаетесь объединить.

Если вы уверены в вышеперечисленном, откройте запрос на притяжение, используя наш PR -шаблон

Предложение и улучшение или функция

Если вы предполагаете, что Идексан добавляет новую функцию или расширяет существующую, пожалуйста, откройте проблему, используя шаблон запроса функции

Обновление документации

Вскоре

Другой

Если у вас есть вопрос или забота, которые не соответствуют вышеуказанному, не стесняйтесь обращаться к нам (см. Свяжитесь с нами)

Стандарты и стиль

Этот репозиторий стремится обеспечить совместимость, однородность и общую разборчивость. Мы предлагаем, если вы пытаетесь внести свой вклад в источник этого проекта, вы прочитали следующее.

Стандарты

Документация