Child pages
  • Contributing code to PrestaShop

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Go to the PrestaShop Github repository.
  2. Fork the project by clicking on the "Fork" button. The fork will appear as a "PrestaShop" repository in your own account.
    You've successfully forked the PrestaShop repository, but so far it only exists on your Github account. To be able to work on the project, you will need to clone it to your local machine.
  3. On your local machine:
    1. Clone your fork:
      1. Create a new folder on your local machine. We'll name it "PS-MyChanges", but you can use whatever name you want.
      2. Get the HTTPS clone URL from your Github PrestaShop repository. It should resemble this: https://github.com/xBorderie/PrestaShop.git
      3. Right-click on you PS-MyChanges folder, and in the Git section of the menu that appears, choose "Git Clone..."
      4. In the window that opens, paste the clone URL in the "URL" field.
      5. Click OK: TortoiseGit will download the files and folders from your Gihub repo.
    2. (optional) Add the "upstream" remote: When a repository is cloned, it has a default remote repository called "origin" that points to your fork on GitHub, not the original PrestaShop repository it was forked from. To keep track of the changes in the original repository and keep your local clone updated, you need to add another remote named "upstream":
      1. Right-click on the PrestaShop folder in the PS-MyChanges folder (it should have a green mark if no change has been made yet), and in the ToroiseGit submenu, choose "Settings..."
      2. Open the Git/Remote section of the option panel.
      3. Type "upstream" in the "Remote field".
      4. From PrestaShop Github repository, copy the HTTPS clone URL and paste it in TortoiseGit's "URL" field.
      5. Click the "Add new/Save" button. TortoiseGit asks you if you want to disable tag fetching: choose "No".
      6. TortoiseGit asks you if you want to fetch remote branches from the newly added remote: choose "Yes".
      7. TortoiseGit displays a summary window: click "OK". A window will open showing that Git is fetching data. Close it once it is done, and close the still-open Settings window.
    3. Make your changes:
      1. Edit all the necessary files. As soon as you save and edited file, Windows will change its icon from green to red to indicate that it has been changed since the last update.
    4. Submit your changes to your Github repository:
      1. Once you are done editing the local files, reach the root of your local repository (the "PrestaShop" folder in PS-MyChanges).
      2. Right-click on the folder and choose "Git Gui". This will open an interface. The files you have changed should appear in the "Staged Changes (Will commit)" section. If they are in the "Unstage Changes" window instead, select them and click on the "Stage Changed" button to move them to the "Staged Changes" section.
        • Make sure to only stage the files that you meant to change for this commit, but not any other changed files! For instance, PrestaShop and its modules might change some configuration files: do not ever stage then commit them!
      3. Write a commit message for your changes. Be sure to follow the commit message norm.
      4. Click the "Commit" button: your changes are now committed to your local Git repository.
      5. Click the "Push" button: a window opens, asking you to which branch the commit should be pushed – usually it should be "1.6". Leave "origin" as the remote setting, and click "Push".
      6. TortoiseGit open a window showing the current status, and might also open an OpenSSH window asking you for your Github username, then your Github password. Give them both and validate: the status window should push your changes to your Github repository. Success! You can close the TortoiseGit windows: the rest will happen on Github.
  4. Submit your changes to the PrestaShop repository: Now that your changes are stored on Github, you need to let them be known to the PrestaShop developers. This is done by creating a "pull request", which can be seen as a suggestion all the files you have committed. Github has an excellent help page about creating pull requests, but here is a summary:
    1. Go to your own PrestaShop repository on Github.
    2. Either click on the "Pull Request" or the "Compare" button. Both will open the same screen, comparing your latest commit to the original code.
    3. The top of the screen indicates what is being compared. It should be PrestaShop's 1.6 branch with your own 1.6 branch. You should not have anything to change here, just make sure that the base fork is the PrestaShop repository, and that your own repository is the head fork.
    4. Click on the "Create a pull request" button. A new screen should appear, in which you can review your changes and give your pull request a title (it should already use the commit message you used from your local clone). 
      • This title is only for internal use at GithubgGithub: it helps the developer, but only your commit message is kept in the project's Git history. In any case, most of the time you won't need to it the title: keep the commit message.
    5. Click on the "Send pull request" button: Github open a screen where you can start a conversation about your pull request, right in PrestaShop's Github repository. Congratulation, your changes are now ready to add to the PrestaShop codebase!
  5. Wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code.

...