Get familiar with pgRouting and Prepare to the first contribution

XJTUmg commented 6 years ago

The following TODOs are for who wants to contribute to pgRouting.

Setup the environment locally

[x] Fresh and clean Ubuntu Linux system.
[x] Setup pgRouting dependencies (including optional), follow the guidance.
[x] Setup postgres, make sure you could create a database and other basic operations.

Being a user of pgRouting

[x] Clone pgRouting locally and compile & run it. Hint, use run.sh.
[x] Following this wiki to generate pgRouting sample graph.
[x] Run dijkstra like functions on that graph. Refer to https://docs.pgrouting.org/latest/en/dijkstra-family.html#dijkstra.
[x] (Optional) Run other functions in pgRouting.

Be familiar with Git

Git is a really really important version control system for us developers. You will working with Git for many years, even you are in a company. And be sure you know how to work with Git is a dependence of GSoC.

[x] Read Full of chapter 1~3 in this book.
[x] Clone pgRouting main repo (both online and locally).
[x] Clone your pgRouting online clone locally.
[x] Checkout to a new branch named *testMu.
[x] Make some change and push them to your clone online.

Be familiar with pgRouting architecture.

[ ] Read full of pgRouting developer documentation.
[ ] Be familiar postgres sql language.
[ ] Be familiar with Boost.Graph library (this is very important since pgRouting is based on Boost.Graph).
[ ] Book a online meeting with me and I will explain how pgRouting works.
[ ] Do any experiment locally.

First Contribution

Welcome to open source world! Have a nice trip.

[ ] Find some bugs or improvements could be done.
[ ] Contact with me and Vicky to discuss about that (using gitter).
[ ] Fix the bug and make a PR to main repo (develop branch).
[ ] Wait for me and Vicky to review your changes.
[ ] If we approve your changes, you can merge them directly. Otherwise, improve your changes.
[ ] If the bug is very dangerous, you can make a PR from develop to master. Be aware of that the master branch is our main branch, which means you never merge to master directly, merging to master needs to notice the whole community.

XJTUmg commented 6 years ago

@Tivility Pls follow the above guidance.

Tivility commented 6 years ago

@XJTUmg I think I've followed the steps in guidance and setup all the dependencises in a fresh ubuntu system. And I've tested the postgres with some basic operations. Such as create, insert, delete, update, drop... I think it works normal. I'll try to use pgRouting and learn what pgRouting is doing by following 'Being a user of pgRouting' in the next few days.

Tivility commented 6 years ago

@XJTUmg I cloned the pgRouting from git and compile it with test_compile 7. Then I fellow the wiki and input the sample graph in my local postgresql. I've tried most of functions in Routing Funcions which data depended on the sample data(include all dijkstra like functions). Now, I have a preliminary understanding of what pgrouting is doing. I'll get familiar with git as soon as possible.

Tivility commented 6 years ago

@XJTUmg , I read the book you mentioned. Then follow the steps in "Be familiar with Git" . I push one test file mytest to the new branch *testMu on my online clone successfully.

I'll get familiar with pgRouting architecture in the next few days.

Tivility commented 6 years ago

@XJTUmg I think I've read the full of pgRouting developer documentation at this page. Then, I looked through the postgre sql documentation at this page. Just part of the postgre sql language in Chinese version of the doc. I've get touch with mySql before, so I think I could use postgre sql now.

I'll learn Boost.Graph library carefully in next periods of time.

Tivility commented 5 years ago

@XJTUmg I have left this project for a while. And I will continue to learn what you mentioned before in the next period of time. Maybe I need to review what I learned before...

ApocalypseYun commented 5 years ago

Mark

XJTUmg / pgrouting