GitHub BananaAccounting

In this article

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. Clone the repository
  3. Create a new Branch
  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

anchor

Install Github Desktop

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

anchor

Clone the repository

The second step is to clone the forked repository:

  1. Click the green button Clone or download -> Open in Desktop -> . GitHub Desktop should automatically open.
  2. Choose a path on your local machine to clone the repository.
  3. 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.

anchor

Create a new Branch

In order to complete this phase you have to do the following steps:

  1. In GitHub Desktop press the upper and centered button Current Branch -> New Branch -> Insert in the window that just appeared the name for the Branch.
  2. Choose the Branch from which you want to fork, by default is master.
  3. Click the button Create Branch.
  4. Click the blue button Publish branch.

Now you have your own Branch to work on the project.

anchor

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 <your_branch_name>.
  7. Click the blue button Push Origin.

anchor

Sync your branch with the master branch

This is a fundamental step, which should be repeated multiple time when you're modifying files of a repository, by repeating this process you avoid conflicts with the master branch.

In order to Sync a fork of a repository to keep it up-to-date with the upstream repository follow the following step:

Open GitHub Desktop -> Click the upper button on the right Fetch origin

Now your branch should be in sync with the project master branch.

anchor

Submit the changes (Pull request)

To submit changes with GitHub desktop:

  1. Start GitHub Desktop
  2. Choose the repository
  3. Click the blue button Create Pull Request
  4. You should be redirected to your browser on the GitHub page of the project, here add a comment title and a comment text for the pull request, it helps a lot for other people to understand what you changed so be precise and follow these two steps:
    • 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).
  5. Click the button Create Pull Request
  6. Will appear a message which will verify if you branch has created conflicts, in order to avoid them remember to repeat more and more times the Sync forked repository with the master repository step.

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 | LinkedIn | Email