Contributing
Ласкаво просимо і дякуємо за те, що розглядаєте можливість долучитися до цього проекту! Ваша участь є життєво важливою для розвитку та успіху цієї ініціативи з відкритим вихідним кодом.
*Незабаром цей розділ буде доповнено простішими кроками для підготовки всього необхідного.
Ми щиро вітаємо ваші внески! Ми висловлюємо подяку всім, хто долучився до створення цього сховища. Якщо у вас є запитання чи пропозиції, будь ласка, відкрийте тему. Для отримання додаткової інформації див. посібник зі створення внесків.
Будь ласка, відвідайте цю спеціальну вікі-сторінку, щоб переглянути повний список авторів та дописувачів. Щоб зробити внесок у Relivator, виконайте наступні кроки:
- Почніть з прочитання розділу “Як встановити і почати роботу” у верхній частині цього репозиторію, а також сторінки CONTRIBUTING.md.
- Створіть гілку:
git checkout -b <назва_гілки>
. - Внесіть і зафіксуйте зміни:
git commit -m '<повідомлення_фіксації>'
. - Перенесіть до початкової гілки: `git push origin <назва_гілки>’
- Надішліть запит на вилучення.
Крім того, зверніться до документації GitHub про те, як створити запит на вилучення (https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
Початок роботи
- Вилка та налаштування: Розпочніть свій шлях створення внеску шляхом розгалуження сховища. Дотримуйтесь інструкцій з налаштування у README.md.
- Кодекс поведінки: Ознайомтеся з нашим Кодексом поведінки. Дотримання цих принципів очікується від усіх членів спільноти.
Керівництво по внесках
Дотримання правових норм
- Оригінальність: Переконайтеся, що ваш внесок є повністю оригінальною роботою.
- Права: Переконайтеся, що ви володієте необхідними правами на свій внесок.
- Дотримання ліцензії**: Всі внески повинні відповідати умовам ліцензування проекту.
Протокол запиту на вилучення
- Внески до інтерфейсу користувача: Для змін, пов’язаних з інтерфейсом, використовуйте Шаблон запиту на вилучення інтерфейсу. Додавайте скріншоти, щоб полегшити процес розгляду.
- Загальні внески: Для інших типів внесків використовуйте Загальний шаблон. Надайте опис вашого внеску.
Процес повідомлення про вади
Попередні кроки
- Дослідження: Переконайтеся, що про ваду ще ніхто не повідомляв.
- Вичерпна інформація: Зберіть всі відповідні деталі, щоб точно описати проблему.
Як подати звіт про ваду
- Проблеми GitHub: Використовуйте GitHub Issues для повідомлення про вади.
- Чіткість і деталізація: Чітко формулюйте як очікувану, так і фактичну поведінку, а також описуйте кроки для відтворення помилки.
- Занепокоєння щодо безпеки: Щоб повідомити про вразливості безпеки, звертайтеся безпосередньо до нас за адресою blefnk@gmail.com, а не використовуйте загальнодоступні канали.
Пропозиції щодо вдосконалення
Попередні міркування
- Перевірка версій: Переконайтеся, що ви працюєте з останньою версією програмного забезпечення.
- Існуючі пропозиції: Шукайте GitHub Issues і наш Discord Suggestions Channel, щоб побачити, чи не було вже внесено таку пропозицію.
- Відповідність проекту: Оцініть, чи відповідає пропозиція цілям проекту.
Як запропонувати покращення
- Описова назва: Виберіть назву, яка стисло описує покращення.
- Детальна пропозиція**: Надайте покрокову розбивку запропонованого вдосконалення.
- Обґрунтування**: Поясніть, чому це покращення буде цінним для проекту.
Внесення першого внеску коду
- Вибір проблеми: Виберіть проблему з GitHub issues і попросіть призначити її.
- **Створення розгалужень та гілок: Зробіть форк сховища і створіть нову гілку, назвавши її за номером випуску.
- **Фіксація змін: Дотримуйтесь чіткого стилю фіксації, посилаючись на випуск у повідомленні про випуск або у повідомленні про фіксацію.
- **Подання запиту на вилучення: Запропонуйте зміни за допомогою pull-запиту з розгалуженого репозиторію.
Додаткові ресурси
Приклади ефективних назв коммітів
| Ефективний приклад | 🟢 Ефективний приклад | 🟡 Менш ефективний приклад | 🔴 Поганий приклад | --------------------------------------------------- | ------------------------- | ------------------ | | add(i18n): додати підтримку інтернаціоналізації для RSC | додано новий матеріал | YOOOOOOOO | перерозподіл кошика для зручності користувачів | виправлено проблему з кошиком | виправлено річ | виправлено річ | upd(docs): виправлено друкарські помилки у README | оновлення документів | (docs)Довірся мені, брате | (docs)