GitHub BananaAccounting

Contribute to the BananaAccounting GitHub repository

In order to contribute to the BananaAccounting GitHub repository and submit your changes it is necessary to follow some basic steps:

  1. Install GitHub Desktop
  2. Fork the repository
  3. Clone the repository
  4. Modify or add files to the repository
  5. Keep in sync with the BananaAccounting repository
    (Repeat this step frequently!! It downloads the changes from the BananaAccounting main repository into your local repository, preventing conflicts).
  6. Submit the changes

Install Github Desktop

Install GitHub Desktop on your computer, and (if you don't have it already) create your own account.

    Fork the repository

    The first step is to fork your own copy of the repository you want to work on to your account:

    1. Go to the Banana Accounting's main page in github
    2. Click on the repository that you wish to fork
    3. Click the button Fork on top right of the page
    4. Select your Account

    Clone the repository

    The second step is to clone the forked repository:

    1. Click the green button Clone or download -> Open in Desktop -> Open link. GitHub Desktop should automatically open.
    2. Click the button Clone and wait a moment while the forked repository is cloned on your local machine.

    At this point, you have created on your computer your own copy of the repository.

    Modify or add files to the repository

    To work with the repository:

    1. Start GitHub Desktop
    2. Choose the repository you want to work on
    3. Menu Repository -> Show in Explorer
    4. Work on the repository, create and/or edit the files that you wish to change.
    5. Open GitHub desktop again, your changes should be visible on the left side of the window.
    6. Commit the changes to your own repository by clicking on Commit to master and then on the Pull button.

    Sync forked repository with the BananaAccounting repository

    Prior to work on your local files, make sure you have the latest copy of the files. If you do changes before updating the files you will end up having conflicts.

    There are two steps to follow in order to sync a fork of a repository to keep it up-to-date with the upstream repository:

    1. Configure a remote for a fork

    2. Sync a fork

    Configure a remote for a fork

    Configure a remote that points to the upstream repository in Git to sync changes you make in a fork with the original repository.
    See https://help.github.com/articles/configuring-a-remote-for-a-fork/.

    This procedure which creates the upstream have to be executed only once. After that the system remembers this upstream. In this case go directly to Sync a fork.

    1. GitHub Desktop -> Menu Repository -> Open in Command prompt
    2. Write the following commands:
    1) git remote -v
    2) git remote add upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git
    3) git remote -v

    Replace ORIGINAL_OWNER with BananaAccounting, and ORIGINAL_REPOSITORY with the name of the repository (i.e. .../BananaAccounting/Netherlands).

    Sync a fork

    Sync a fork of a repository to keep it up-to-date with the upstream repository.
    See https://help.github.com/articles/syncing-a-fork/.

    1. GitHub Desktop -> Menu Repository -> Open in Command prompt
    2. Write the following commands:
    1) git fetch upstream
    2) git checkout master
    3) git merge upstream/master

    Your forked repository should be in sync.

    Submit the changes (Pull request)

    To submit changes with GitHub desktop:

    1. Start GitHub Desktop
    2. Choose the repository
    3. Click on Menu Branch -> Create Pull Request
    4. On the opened page of the browser set:
      1. base fork: select the BananaAccounting repository (example: BananaAccounting/Netherlands)
      2. base: select the master branch of the BananaAccounting repository
      3. head fork: select your own repository (example: YourAccountName/Netherlands)
      4. compare: select the master branch of the repository
    5. Click the button Create Pull Request
    6. Add a comment title and a comment text for the pull request.
      • Explain exactly what changes you have made, so that the moderator can more easily accept the changes.
        It will also help you later to understand what has been done.
        It it is worth to dedicate some time to doing good comments.
      • You can comment also groups of files you have changed. (see github documentation).
    7. Click the button Create Pull Request

    The repository moderator will receive the pull request, evaluate and approve or refuse the contribution.

    You will be notified by email when the pull request has been accepted.

    Important:

    • Do not click on the "Close Pull Request" button, or the pull request will be blocked!
    • If the system tell you that there are conflicts, you should not submit the pull request.
      Conflicts are probably due to the fact that you have not synched you repository with the Banana Accounting repository.
      Eventually:
      • do a copy of your repository.
      • resync again or in case clone again the main repository.
      • copy the changed files from the copy repository to the correct one.
      • Redo the pull request process.

     

    Help us improve the documentation

    We welcome feedback on how to improve this page.

    Tell us what theme needs a better explanation or how to clarify a topic.

    Share this article: Twitter | Facebook | Email