View source for Contribuir para o Nominatim

== Nominatim ==

O código fonte do projeto [https://github.com/openstreetmap/Nominatim Nominatim] está disponível no GitHub.

Antes de qualquer contribuição, deve-se ler o documento [https://github.com/openstreetmap/Nominatim/blob/master/CONTRIBUTING.md CONTRIBUTING].

Procurar issues que estejam marcados como simple:

<syntaxhighlight lang="bash">
is:open label:simple 
</syntaxhighlight>

=== Ciclo de vida ===

# Fork p/ a nossa conta 
# clone localmente
# Criar um branch local
# Fazer as contribuições e testar
# Commit & push
# Fazer o Pull Request

==== Fork ====

Faz-se na interface do GitHub. 

Por uma questão de nomenclatura, os repositórios para a ter os seguintes nomes:
* ''upstream'': nome para o repositório https://github.com/openstreetmap/Nominatim
* ''origin'': nome para a nossa cópia https://github.com/jgrocha/Nominatim

==== Clone ====

Fazemos o clone do nosso repositório no GitHub 

<syntaxhighlight lang="bash">
mkdir -p ~/dev
cd dev
git clone git@github.com:jgrocha/Nominatim.git
git clone --recursive git@github.com:jgrocha/Nominatim.git
</syntaxhighlight>

<syntaxhighlight lang="bash">
cd Nominatim
git remote -v
origin	git@github.com:jgrocha/Nominatim.git (fetch)
origin	git@github.com:jgrocha/Nominatim.git (push)
</syntaxhighlight>

Foi criado automaticamente a referência para o nosso repositório do GitHub com o nome ''origin''. Falta criar um referência com o nome ''upstream'' para o repositório oficial do Nominatim.

<syntaxhighlight lang="bash">
git remote add upstream git@github.com:openstreetmap/Nominatim.git
git remote -v
origin	git@github.com:jgrocha/Nominatim.git (fetch)
origin	git@github.com:jgrocha/Nominatim.git (push)
upstream	git@github.com:openstreetmap/Nominatim.git (fetch)
upstream	git@github.com:openstreetmap/Nominatim.git (push)
</syntaxhighlight>

==== Branch ====

<syntaxhighlight lang="bash">
git checkout -b issue823
Switched to a new branch 'issue823'
</syntaxhighlight>

Garantir que o projeto compila direito (na linha de comandos). Corrigir dependências, se necessário.

<syntaxhighlight lang="bash">
mkdir build
cd build
cmake ..
make
</syntaxhighlight>

Opcionalmente, deve-se abrir e usar o projeto num IDE que suporte C. [https://www.jetbrains.com/clion CLion] can be used for open source project, according to it's [https://www.jetbrains.com/buy/opensource/ license].

==== Dependências ====

<syntaxhighlight lang="bash">
sudo apt install libboost-system-dev libboost-filesystem-dev python-pyosmium python3-pyosmium
</syntaxhighlight>

<syntaxhighlight lang="bash">
sudo ln -s /usr/lib/x86_64-linux-gnu/libboost_python-py35.so.1.58.0 /usr/lib/x86_64-linux-gnu/libboost_python-py35.so
sudo ldconfig
</syntaxhighlight>

<syntaxhighlight lang="bash">
sudo su
pip3 install osmium
</syntaxhighlight>

<syntaxhighlight lang="bash">
sudo apt-get install php-pear php-pgsql
sudo pear install DB
</syntaxhighlight>

==== Teste do build ====

<syntaxhighlight lang="bash">
sudo su postgres
createuser --createdb --pwprompt --superuser jgr
Enter password for new role: nominatim
Enter it again: nominatim

createuser www-data
exit
</syntaxhighlight>

<syntaxhighlight lang="bash">
echo "localhost:5432:*:jgr:nominatim" >> ~/.pgpass
</syntaxhighlight>

Atenção: a importação é bastante demorada (aprox. 25 minutos para importar Portugal)

<syntaxhighlight lang="bash">
cd ..
wget -O data/portugal-latest.osm.pbf http://download.geofabrik.de/europe/portugal-latest.osm.pbf
wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
./build/utils/setup.php --osm-file data/portugal-latest.osm.pbf --all
</syntaxhighlight>

==== Undo ====

<syntaxhighlight lang="bash">
sudo su postgres
psql 
postgres=# DROP DATABASE nominatim;
DROP DATABASE
postgres=# DROP ROLE jgr;
DROP ROLE
postgres=# \q
</syntaxhighlight>

==== Contribuições ====

==== Commit and push ====

==== Pull request ====