Contributing Guide

Сторінка окреслює як можна долучитися до покращення індексу.

Загальне

• Структура проєкту окреслює загальну структуру проєкту.

• Зауваження щодо параметрів/якості даних можна залишити створивши issue.

• Вітаються pull request із запропонованими змінами до вихідного коду.

Як запропонувати зміни?

Примітка

Цей розділ окреслює технічні аспекти роботи з GitHub. Якщо немає потреби долучатися до роботи над індексом, цю частину сміливо можна пропускати

• Fork the repo - <https://github.com/regional-development/index-2020-3>

• Check out a new branch based and name it to what you intend to do:

  • Example:

  $ git checkout -b BRANCH_NAME
  

  If you get an error, you may need to fetch fooBar first by using:

  $ git remote update && git fetch
  

  • Use one branch per fix / feature

• Commit your changes:

  • Please provide a git message that explains what you’ve done

  • Please make sure your commits follow the conventions

  • Commit to the forked repository

  • Example:

  $ git commit -am 'Add some fooBar'
  

• Push to the branch

  • Example:

  $ git push origin BRANCH_NAME
  

• Make a pull request

  • Make sure you send the PR to the fooBar branch