Skip to content

Commit

Permalink
Added contributing files (#618)
Browse files Browse the repository at this point in the history
* Added contributing files

* Update CONTRIBUTING.md
  • Loading branch information
MariaAfonina authored Oct 27, 2023
1 parent d863134 commit 994468c
Show file tree
Hide file tree
Showing 2 changed files with 143 additions and 0 deletions.
69 changes: 69 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# How to Contribute 🛠️

## Step 1: Find an Issue

Browse the open issues in the main repository and pick one you want to work on.
Or create one if you have found a bug or have a feature request.

## Step 2: Fork the Project 🍴

Click the "Fork" button on the main page of the repository to make a copy in your own account.

## Step 3: Clone the Project 🌿

Clone the Project by HTTPS or SSH and open this localy.

## Step 4: Environment 🌿

```bash
$ git checkout develop
```

- Set up your project by adding your .env variables

```bash
$ npm ci
```

```bash
$ git checkout -b your_branch_name
```

## Step 5: Work on the Task 👨‍💻👩‍💻

Make the necessary changes in the code or documentation.

## Step 6: Test your code

Make sure that the changes you've made work locally before creating a Pull Request

## Step 7: Commit ✅

Add your changes through Git and create a commit with a descriptive message.

```bash
$ git add .
```

Create a Commit

```bash
$ git commit -m 'Your descriptive message'
```

NOTE: Each pull request (PR) should contain only one commit. If you have multiple commits, they need to be squashed.

## Step 8: Work Remotely 🌍

When your work is ready and complies with project conventions, upload your changes to your fork:

```bash
# Push your work to your remote repository
$ git push -u origin Branch_Name
```

## Step 9: Create a Pull Request ➡️

- Go to the page of your fork on GitHub and click "New Pull Request".
- You should create pull request to base develop branch.
- Verify that the changes are displayed correctly, and then submit your pull request.
74 changes: 74 additions & 0 deletions CONTRIBUTING_UA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Вказівки щодо внесків (Contributing Guidelines)

## Як зробити внесок 🛠️

## Крок 1: Знайти проблему

Перевірте відкриті завдання (issues) у головному репозиторію та оберіть одне, над яким хочете працювати.
Або створіть нове, якщо ви знайшли помилку або маєте запит на новий функціонал.

## Крок 2: Створити форк проекту 🍴

Натисніть кнопку "Fork" на головній сторінці репозиторію, щоб створити його копію в вашому обліковому запису.

## Крок 3: Клонувати проект 🌿

Клонувати проект використовуючи HTTPS або SSH та відкрити його локально.

## Крок 4: Середовище

```bash
$ git checkout develop
```

- Налаштувати проєкт, додавши свої змінні .env та додавши туди свої дані.

```bash
$ npm ci
```

```bash
$ git checkout -b your_branch_name
```

## Крок 5: Робота над завданням 👨‍💻👩‍💻

Спочатку вам необхідно запустити Back-end частину:
https://github.com/ita-social-projects/SpaceToStudy-BackEnd

Робіть необхідні зміни в коді або документації.

## Крок 6: Тестування

Переконайтесь, що код працює у вашому локальному середовищі перед тим, як створювати Pull Request

## Крок 7: Коміт ✅

Додайте ваші зміни через Git і створіть коміт з описовим повідомленням.

```bash
$ git add .
```

# Створити коміт

```bash
$ git commit -m 'Ваше описове повідомлення'
```

УВАГА: Кожний pull request (PR) повинен містити лише один коміт. Якщо у вас є декілька комітів, їх потрібно об'єднати (squash).

## Крок 8: Працювати віддалено 🌍

Коли ваша робота готова і відповідає конвенціям проекту, завантажте зміни на ваш форк:

```bash
# Відправити вашу роботу до вашого віддаленого репозиторію
$ git push -u origin Назва_Гілки
```

## Крок 9: Створити запит на злиття (Pull Request) ➡️

- Перейдіть на сторінку вашого форку на GitHub і натисніть "New Pull Request".
- Створіть Pull Request в базову гілку develop.
- Перевірте, що зміни відображаються правильно, і надішліть запит на злиття.

0 comments on commit 994468c

Please sign in to comment.