Как внести свой вклад в исходный код

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

Вклад кода через Gitee

В настоящее время микросервис использует Git для контроля версий программы. Если вы хотите внести свой вклад в проект, сначала ознакомьтесь с основами использования Git. В настоящее время проект размещается на платформе Gitee, и любой пользователь Gitee может внести свой вклад.

Процесс участия очень прост:

1. Скопируйте (fork) код микросервиса в свой репозиторий.
2. Внесите изменения и отправьте их (commit).
3. Отправьте запрос на объединение (pull request) нам. Мы оперативно рассмотрим и обработаем ваш запрос.
4. После успешного прохождения проверки ваш код будет объединён (merge) с нашим репозиторием, и вы автоматически попадёте в список участников. Это очень удобно.

Мы ожидаем, что ваш код соответствует следующим требованиям:

• стандартам кодирования микросервиса;
• содержит соответствующие комментарии для облегчения понимания другими разработчиками;
• следует лицензии GPL-3.0 с открытым исходным кодом.

Если у вас есть дополнительные вопросы или нужна дополнительная информация, пожалуйста, продолжайте читать.

Замечания

Правила именования

• Файлы интерфейса микропрограммы должны иметь имена в стиле «lowerCamelCase».

let homePage = []
let name = '小明'

• Имена классов должны быть написаны строчными буквами и соединены дефисами. Например:

<view class="home-page"></view>

• Именование переменных JavaScript должно следовать стилю camelCase. Для констант рекомендуется использовать заглавные буквы или начинать с заглавной буквы.

const AudioContext = wx.createInnerAudioContext() 
const API = {}

Написание CSS

Правила написания стилей CSS или wxss должны соответствовать принципу вложенности элементов и иерархической структуры. Следует избегать смешивания стилей.

Пример неправильного подхода:

.home-page{}
.header{}
.title{}

Правильный подход:

.home-page{}
.home-page .header{}
.home-page .header .title{}

Обратите внимание: при использовании чувствительных слов, таких как «header» и «title», необходимо соблюдать особые ограничения, чтобы избежать путаницы стилей. Решение о том, как это сделать, остаётся за разработчиком.

Использование rpx и px

Атрибуты, такие как ширина, высота, отступы, поля, верх, низ, право и лево, должны использовать единицы измерения rpx, если они основаны на ширине экрана 750rpx.

Единицы измерения px используются для атрибутов, таких как размер шрифта, тень блока, радиус границы и граница.

Обработка JS

Рекомендуется определять переменные JavaScript в соответствии со следующими правилами:

• Переменные, определённые в data, должны использоваться в wxml. Другие значения следует помещать в pageData.

  Page({
      
      data: {}
      pageData:{}
  })

Рекомендации по app.js в проекте микропрограммы

• Старайтесь не выполнять запросы или переходы в app.js, так как это может привести к проблемам при разработке и чёрному экрану.
• Если требуется переход или запрос, рекомендуется добавить промежуточную страницу с анимацией загрузки.

Структура каталогов

• components — папка для общих компонентов.
• assets — папка для статических ресурсов.
• pages — папка для всех страниц.
• utils — папка для всех функций утилит (включая упакованные ajax).
• readme.md — файл описания проекта.

Функции утилит должны быть помещены в папку utils.

Gitee Issue

Gitee предоставляет функцию Issue, которая может использоваться для:

• сообщения об ошибках;
• предложения улучшений;
• обратной связи об опыте использования.

Эта функция не должна использоваться для:

• предложений по изменению (связанных с авторством кода и отслеживанием изменений);
• недружелюбных высказываний.

Быстрое редактирование

Gitee предлагает функцию быстрого редактирования файлов.

1. Войдите в свою учётную запись Gitee.
2. Просмотрите файлы проекта и найдите файл, который нужно изменить.
3. Нажмите на значок карандаша в правом верхнем углу, чтобы начать редактирование.
4. Введите соответствующую информацию в поле «Commit changes» (обязательно укажите Title).
5. Отправьте изменения и дождитесь проверки CI и объединения администратором.

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

Полный процесс

1. Fork текущего проекта.
2. Клонируйте свой forked проект на локальный компьютер.
3. Создайте новую ветку и переключитесь на неё.
4. Добавьте текущий проект в качестве восходящего потока в свой локальный репозиторий git.
5. Слейте вашу ветку с основной веткой upstream.
6. Push ваш локальный репозиторий на Gitee.
7. Отправьте pull request.
8. Дождитесь проверки CI (если проверка не пройдена, повторите шаги 5–7, Gitee автоматически обновит ваш pull request).
9. Подождите, пока администратор обработает запрос, и своевременно объедините вашу ветку с основной ветвью upstream (если в основной ветке upstream есть изменения).

При необходимости вы можете принудительно отправить обновлённую после rebase ветку в свой fork

Категорически запрещено использовать принудительную отправку для внесения изменений в вышестоящий репозиторий

Замечания

• Если у вас есть какие-либо вопросы относительно процесса, обратитесь к руководству по GIT, например, этому.
• Для изменений в разных аспектах кода рекомендуется создавать разные ветки в вашем forked проекте (см. примечание в пункте 9 полного процесса).
• Информацию о слиянии и интерактивном слиянии см. в разделе «Git Interactive Rebase» здесь.