Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Git workflow added to Developer Manual #485

Merged
merged 2 commits into from Aug 14, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 48 additions & 0 deletions Developer_Manual.rst
Expand Up @@ -406,6 +406,54 @@ The "git flow" model
those changes.


Nuitka "git/github" Workflow
=====================

* Forking and cloning

You need to have git installed and GitHub account. Goto Nuitka repository
<https://github.com/Nuitka/Nuitka> and fork the repository.

To clone it to your local machine execute the following your git bash:

.. code-block:: sh
$ git clone https://github.com/your-user-name/Nuitka.git
$ cd Nuitka
$ git remote add upstream https://github.com/Nuitka/Nuitka.git

* Create a Branch

.. code-block:: sh
$ git checkout develop
$ git pull upstream develop
$ git checkout -b feature_branch

If you are having merge conflicts while doing the previous step, then
check out (DON'T FORGET TO SAVE YOUR CHANGES FIRST IF ANY): <https://stackoverflow.com/questions/1125968/how-do-i-force-git-pull-to-overwrite-local-files>

* In case you have an existing branch rebase it to develop

.. code-block:: sh
$ git rebase upstream/develop

Fix the merge conflicts if any, stash them and continue:

.. code-block:: sh
$ git rebase --continue

If anything goes wrong while rebasing:

.. code-block:: sh
$ git rebase --abort

* Making changes

.. code-block:: sh
$ git commit -am "Commit Message"
$ git push –set-upstream origin feature_branch (one time)
$ git push


API Documentation and Guidelines
================================

Expand Down