tutorial for beginners
######################

step-by-step
============

let's review the steps to start contributing:

-  Fork the project to your account.

-  Choose a path in your computer to store the project, go to it.

-  Clone the fork that you have just done to this path using the
   terminal command

   ``git clone https://github.com/YOUR-USERNAME/bradata``

-  At this point, you should have an exact copy of the latest version of
   the project on your machine.

Congratulations! Now you have a version of the repository in your
machine. If you want to contribute and help to build this incredible
project, keep reading!

-  do your modifications.

-  now you must check if your version is up-to-date with the original
   repository:

   ``git pull https://github.com/labFGV/bradata``

-  if you have a merge conflict, you must solve it before committing
   your work.

-  now you stage and commit your work:

   ::

       git add YOUR_FILES
       git commit -m "YOUR COMMIT MESSAGE"

-  now you push the changes to your repo: ``git push origin master``

-  finally, you go to https://github.com/labFGV/bradata and complete
   your pull request.

how-to's
========

google and stackoverflow are your best friends, but:

-  git:

   -  dudler's simple guide:
      `en <https://rogerdudler.github.io/git-guide/>`__,
      `pt-br <https://rogerdudler.github.io/git-guide/index.pt_BR.html>`__
   -  `official docs <https://git-scm.com/doc>`__
   -  `oh, sh\*t, git! <http://ohshitgit.com/>`__
   -  github `guides <https://guides.github.com/>`__ &
      `help <https://help.github.com/>`__
   -  

-  markdown:

   -  `learn in 60 seconds <http://commonmark.org/help/>`__
   -  `syntax specs <http://spec.commonmark.org/>`__
   -  `syntax philosophy and some
      specs <daringfireball.net/projects/markdown/syntax>`__
   -  

-  Restructured text

    -  ` Restructured text and sphinx <http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_
    -  

-