Skip to main content

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

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

Прежде всего, спасибо, что решили внести свой вклад в Autonomys Network. It's through the amazing collaboration of people like yourself that truly make the open source community amazing. ❤️

Help Us Help You Help Us!​

Following these guidelines shows that you respect the time of the developers who maintain this open source project. В свою очередь, они должны отвечать взаимностью на это, решая ваши проблемы, оценивая изменения и помогая вам завершить работу над вашими pull requests.

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

We are a fully open source project, meaning we welcome all kinds of contributions from the community. Вот несколько примеров вкладов, к которым мы открыты:

  • Add Content: Writing a nice guide? Отправьте его на форум гайдов.
  • **Отчеты об ошибках и исправлениях: Нашли баг или ошибку? Дайте нам знать, где она скрывается. Сообщите об этом на форуме поддержки.
  • **Запрос и реализация функций: Хотите новую функцию? Поделитесь своими идеями, чтобы мы могли улучшить.

Если у вас есть что-то, чего нет в списке, постарайтесь описать это как можно подробнее и не стесняйтесь отправить pull request.

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

Please refer to our Code of Conduct.

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

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

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

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

  1. Перейдите в раздел Autonomys Documentation и найдите страницу, которую вы хотите изменить.
  2. Прокрутите вниз и нажмите ссылку Edit this page.
  3. This will open the page in GitHub’s web editor.
  4. Once you are satisfied with your changes, click the ‘Commit changes…’ button in the top right, fill Commit message and Extended description.
  5. Нажмите Создать Pull Request

💡 Tip: Submitting a change will create a new branch in your newly created fork (<your_github_name>/subspace-docs), so you can send a pull request.
Sending a PR through the website is simpler but has it's limitations.

🎉Поздравляем! Вы только что отправили свой первый pull request! Пожалуйста дайте некоторое время команде, чтобы просмотреть ваш запрос и одобрить его, либо запросить корректировки.

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

Не стоит беспокоиться! We all start somewhere. 🚀 There are several videos and resources online to show various ways to use GitHub. Ознакомьтесь с некоторыми из этих замечательных руководств, которые помогут вам освоить GitHub и внести свой вклад.

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

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

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

  • Do not comment simple, trivial code such as importing existing components, and basic HTML/CSS.
  • Комментируйте сложный и нетривиальный код, сложная логика должна быть понятна.
  • Все публичные функции должны быть прокомментированы.
  • Если код тривиален, но со временем может быть забыт, пожалуйста, прокомментируйте его.
  • Try to think about your code from a 3rd person view, it should make sense to anyone with a similar background in the technology that you are using.
  • Иногда сложный для понимания код нуждается в рефакторинге, а не в дополнительных комментариях.
  • Make sure the program still builds before submitting a pull request.

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

  1. Создайте свою собственную ветвь кода. Fork
  2. Выполните изменения локально на своей системе в предпочитаемой среде разработки.
  3. Следуя инструкции README.md, протестируйте Ваши изменения локально с помощью yarn build и yarn run serve или npm build и npm run serve, чтобы избежать явных проблем.
  4. Сохраните изменения в свою ветвь и отправьте pull request путем сравнения между ветвями. Отправить Pull Request

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

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

  • Если вы обнаружили фактическую ошибку программирования, пожалуйста, отправьте запрос на GitHub и используйте метку bug.
  • Если вы обнаружили ошибку грамматики/орфографии/содержания, отправьте запрос на GitHub и используйте метку documentation.

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

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

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

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

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

Сообщество

You can chat with the core team on Discord https://autonomys.xyz/discord.