Дељење истраживачког софтвера

Истраживачки софтвер обухвата изворни програмски код, алгоритме, програмске скрипте, рачунарске токове рада и извршне датотеке развијене током истраживања или за потребе истраживања – све од једноставних програмских скрипти, па до сложених апликација. Иако се сматра самосталним резултатом истраживања, истраживачки софтвер се ретко дели са научном заједницом и обично није адекватно документован.

Зашто

Када је програмски код јавно доступан, могуће је проверити примењене методе, поновити анализе и верификовати тврдње изнете у научним публикацијама.
Тако се спречава расипање ресурса, олакшава сарадња између истраживача из различитих дисциплина и убрзава научни напредак.
Повратне информације о проблемима, грешкама, захтевима за спајање и могућим унапређењима могу бити драгоцене за ауторе софтвера.
Различите научне заједнице могу да наставе да развијају софтвер, чиме се доприноси његовој одрживости и омогућава примена у новим контекстима.
Дељењем софтвера испуњавате захтеве финансијера истраживања и институционалних политика, као и очекивања заједнице.
Софтвер депонован у одговарајућем репозиторијуму може се цитирати.
Развој софтвера се све више вреднује приликом запошљавања, напредовања и доношења одлука о финансирању пројеката, па дељење софтвера може позитивно утицати на углед и каријеру аутора.

Како

1. Објавите програмски код у јавном репозиторијуму који омогућава верзионисање (нпр. GitHub, GitLab, BitBucket, Comprehensive R Archive Network - CRAN и др.), како би и све ажуриране верзије могле да се депонују на истом месту и јасно обележе.

2. Пакет који се депонује треба да садржи и README датотеку, у којој су дате основне информације о софтверу (назив, аутори, контакт подаци), јасна упутства за његову инсталацију, покретање кода и пратећих тестова, као и линкови ка повезаним материјалима:

3. Приложите и узорке истраживачких података за које је софтвер намењен или интерактивне свеске које показују како функционише, како би корисници лакше разумели како програм ради, проверили да ли ради онако како је предвиђено и научили да га користе у својим истраживањима.

4. Додајте и текстуалну датотеку са подацима о лиценци како бисте кориснике информисали на који начин и под којим условима могу да користе софтвер. Тако се обезбеђује правна заштита и за ауторе, и за кориснике: Licensing - The Turing Way

5. Креирајте датотеку CITATION.cff помоћу веб-апликације cffinit или у неком програму за уређивање кода. Како репозиторијуми који се обично користе за депоновање софтвера, попут GitHub-а, не користе трајне идентификаторе, софтвер додатно можете депоновати и у репозиторијум Zenodo, који додељује DOI:

6. Креирајте и датотеку CONTRIBUTING.md, у којој се објашњава како други могу да допринесу развоју вашег софтвера (нпр. пријављивањем грешака или предлагањем нових функционалности): How to Build a CONTRIBUTING.md - Best Practices

7. Дефинишите правила понашања – Code of Conduct за сараднике и кориснике у датотеци CODE_OF_CONDUCT.md. Као готово решење за Code of Conduct можете користити Contributor Covenant, али можете дефинисати и своја правила.

Датотеке README, CITATION.cff, CONTRIBUTING.md и CODE_OF_CONDUCT.md треба додати у основни директоријум (root) софтверског пројекта у репозиторијуму.