Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-09 03:04:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

More explicit instructions on using GitHub

Browse Source
This commit is contained in:
Kovid Goyal 2013-06-05 21:32:38 +05:30
parent 45b1443072
commit ef0f0093f8
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
manual/develop.rst
View File

@ -115,16 +115,27 @@ commits::
Be careful to not include merges when using ``HEAD~n``.
If you plan to do a lot of development on |app|, then the best method is to create a
`GitHub <http://github.com>`_ account. Once you have an account, follow the
steps at `Setup Git <https://help.github.com/articles/set-up-git>`_ and
`Fork A Repo <https://help.github.com/articles/fork-a-repo>`_ to create your own fork of the
`calibre GitHub repository <https://github.com/kovidgoyal/calibre>`_. Read
`Pushing to a remote <https://help.github.com/articles/pushing-to-a-remote>`_
to learn how to upload your commits to GitHub.
`GitHub <http://github.com>`_ account. Below is a basic guide to setting up
your own fork of calibre in a way that will allow you to submit pull requests
for inclusion into the main |app| repository:
* Setup git on your machine as described in this article: `Setup Git <https://help.github.com/articles/set-up-git>`_
* Setup ssh keys for authentication to GitHub, as described here: `Generating SSH keys <https://help.github.com/articles/generating-ssh-keys>`_
* Go to https://github.com/kovidgoyal/calibre and click the :guilabel:`Fork` button.
* In a Terminal do::
git clone git@github.com:<username>/calibre.git
Replace <username> above with your github username. That will get your fork checked out locally.
* You can make changes and commit them whenever you like. When you are ready to have your work merged, do a::
git push
and go to ``https://github.com/<username>/calibre`` and click the :guilabel:`Pull Request` button to generate a pull request that can be merged.
* You can update your local copy with code from the main repo at any time by doing::
git pull upstream
You can contribute your code in the form of `Pull Requests
<https://help.github.com/articles/using-pull-requests>`_. Generally, you should
create a new branch for any feature that is non-trivial.
You should also keep an eye on the |app| `development forum
<http://www.mobileread.com/forums/forumdisplay.php?f=240>`_. Before making