Skip to main content

Як зробити внесок!

Ви круті!​

Перш за все, дякуємо, що розглядаєте можливість зробити внесок у мережу Autonomys. 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? Submit it on the forum guides.
  • Повідомлення про помилки та їх виправлення: Знайшли помилку чи баг? Повідомте нам, де вона. Report it at the support forum.
  • Запити на нові функції та їх реалізація: Хочете нову функцію? Поділіться своїми ідеями, щоб ми могли покращити проєкт.

Якщо у вас є щось, чого немає в списку, постарайтеся описати це якомога докладніше і не соромтеся надіслати pull request.

Основні правила

Будь ласка, ознайомтеся з нашим Кодексом поведінки.

Ваш перший внесок

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

Для незначних внесків, таких як виправлення орфографічних помилок, друкарських помилок, переформулювання тощо, дотримуйтесь цього шляху:

For Major Contributions

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

  1. Go to the Autonomys Documentation, and find the page that you would like to change.
  2. Прокрутіть униз і натисніть «Редагувати цю сторінку».
  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. Натисніть Create Pull Request
GitHub Web Editor

When you submit changes through the web editor, GitHub automatically creates a fork of the repository under your account <your_github_name>/subspace-docs and opens a pull request. While this method is convenient for quick edits, it has limitations for more complex contributions.

Congratulations! Ви щойно подали свій перший 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. Надішліть зміни до вашого форку та подайте запит на включення, порівнюючи між форками. Submit Pull Request

How to report a bug or error

We do not have any strict template that you must follow, but please provide all required information so we can quickly resolve any issues.

  • 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.

How to suggest a feature or enhancement

This documentation is for the community, so any feature requests are welcome.

  • If you are requesting a feature, please submit a GitHub issue and use the label enhancement.
  • Explain why this issue is needed, and what problems it will solve.
  • Indicate if you are able/willing to help implement this feature.

Code review process

  • The core team will take a look at any pull requests as soon as possible, generally you can expect a response within a day or two.
  • If it is a simple and non-controversial fix we will review the code and approve.
  • If there are questions, feedback, or more discussion needs to be had we will reach out to the contributor on the Pull Request to try and resolve said issues.
  • If there is no response or activity within 2 weeks of team response we may close the pull request.

Спільнота

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