Перейти к основному содержанию
Версия: последние

Вносим вклад в развитие!

Правильный выбор!​

Прежде всего, спасибо Вам за то, что Вы решили внести свой вклад в развитие Subspace Network. Именно благодаря удивительному сотрудничеству таких людей, как вы, сообщество разработчиков открытого кода становится поистине удивительным. ❤️

Помогите нам, а мы поможем вам!​

Соблюдение этих рекомендаций показывает, что вы уважаете время разработчиков, которые управляют и развивают этот проект с открытым исходным кодом. В свою очередь, они должны отвечать взаимностью на это, решая ваши проблемы, оценивая изменения и помогая вам завершить работу над вашими pull requests.

Что я могу сделать?​

Мы являемся проектом с полностью открытым исходным кодом, что означает, что мы открыты для всех видов вклада со стороны нашего сообщества. Вот несколько примеров вкладов, к которым мы открыты:

  • Added Content: Writing a nice guide? Submit it on the forum guides.
  • Bug Reports & Fixes: Find a bug or error? Дайте нам знать, где она скрывается. Report it at the support forum.
  • Feature Requests & Implementations: Looking for a new feature? Поделитесь своими идеями, чтобы мы могли улучшить.

If you have something that is not listed, try to be as descriptive as possible and feel free to submit the pull request.

Основные правила

Please refer to our Code of Conduct.

Ваш первый вклад

Простое исправление​

Please follow this pathway for minor contributions such as spelling errors, typos, rewording, etc.

If you are adding entirely new pages, features, etc, then please refer to the Advanced portion of this section.

  1. Go to Subspace Documentation, and find the page that you would like to change.
  2. Scroll to the bottom and click Edit this page.
  3. Откроется GitHub, и вы будете перенаправлены на страницу с исходными данными.
  4. In the top right click the pencil emoji to edit the page.
  5. GitHub изменит страницу на текстовый редактор, в котором можно будет вносить изменения.
  6. После того как изменения будут внесены, прокрутите страницу вниз и заполните следующие поля.
    • Заполните заголовок
    • Заполните описание
    • Click the Create a new branch for this commit and start a pull request. option
  7. Click Propose Changes
  8. On the right you will see some options, you will want to apply the most accurate labels listed.
  9. Click Create Pull Request

🎉Поздравляем! Вы только что отправили свой первый pull request! Please provide some time for a maintainer to view your pull request and approve it, or request adjustments.

Никогда раньше не делали вклад?​

Не стоит беспокоиться! Все мы с чего-то начинаем 🚀 В Интернете есть несколько видеороликов и ресурсов, демонстрирующих различные способы использования GitHub. Ознакомьтесь с некоторыми из этих замечательных руководств, которые помогут вам освоить GitHub и внести свой вклад.

Продвинутое исправление​

Этот раздел предполагает более глубокое понимание GitHub, а также основ программирования.

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

  • Do not comment simple trivial code such as importing existing components, and basic HTML/CSS.
  • Комментируйте сложный и нетривиальный код, сложная логика должна быть понятна.
  • Все публичные функции должны быть прокомментированы.
  • Если код тривиален, но со временем может быть забыт, пожалуйста, прокомментируйте его.
  • Попробуйте взглянуть на свой код от третьего лица, он должен быть понятен любому человеку, имеющему опыт работы с технологией, которую вы используете.
  • Иногда сложный для понимания код нуждается в рефакторинге, а не в дополнительных комментариях.
  • Убедитесь, что программа все еще может быть создана и запущена до подачи pull request.

Для более сложных исправлений следует следовать общему пути GitHub.

  1. Create your own fork of the code. Fork
  2. Выполните изменения локально на своей системе в предпочитаемой среде разработки.
  3. Following the README.md instructions, test your changes locally with yarn build and yarn run serve or npm build and npm run serve to ensure there are no clear issues.
  4. Push the changes to your fork and submit a pull request by comparing across forks. Submit Pull Request

Как сообщить об ошибке или неисправности

У нас нет какого-либо строгого шаблона, которому вы должны следовать, но, пожалуйста, предоставьте всю необходимую информацию, чтобы мы могли быстро решить любые вопросы.

  • If you find an actual programming bug, please submit a GitHub issue and use the label bug.
  • If you find a grammar/spelling/content error, please submit a GitHub issue and use the label documentation.

Как предложить функцию или улучшение

Эта документация предназначена для сообщества, поэтому любые пожелания по функциям приветствуются.

  • If you are requesting a feature, please submit a GitHub issue and use the label enhancement.
  • Объясните, зачем нужна эта функция и какие проблемы она позволит решить.
  • Укажите, можете ли вы/хотите ли вы помочь в реализации этой функции.

Процесс рецензирования кода

  • Команда рассмотрит все запросы (pull requests) на внесение изменений как можно скорее, обычно ответ приходит в течение одного-двух дней.
  • Если это простое и непротиворечивое исправление, мы рассмотрим и одобрим код.
  • Если возникнут вопросы, замечания или потребуется дополнительное обсуждение, мы свяжемся с автором Pull Request, чтобы попытаться решить эти вопросы.
  • При отсутствии ответа или активности в течение 2 недель после ответа команды мы можем закрыть pull request.

Сообщество

Вы можете пообщаться с командой в Discord: https://discord.gg/subspace-network