Git authors

From PyMOLWiki
Revision as of 14:28, 1 December 2011 by Tlinnet (talk | contribs) (→‎Git setup)
Jump to navigation Jump to search

Introduction

We need your help to contribute to this project!

If you are interested in moving your script in to the repository, please read through these options.

Github user setup

Create a free account at github

https://github.com/plans

Then go to

https://github.com/Pymol-Scripts/Pymol-script-repo

Near the top right corner, click: Fork

In the top left corner, it should now say: YOUR_NAME / Pymol-script-repo. This is your own repository.
Click HTTP in the middle. We will use this, and it should be like.

https://YOUR_NAME@github.com/YOUR_NAME/Pymol-script-repo.git

Online - make changes to a file

You can change a file online, by clicking it, and then at the right side, click Edit this file.
Make changes, write a "commit message", and in the lower right, click Commit changes.
If you want to your changes to be part of the official repository, click Pull Request, and write a message.
This will notify the group of admins to review your changes.
If the changes reasonable and not malicious for the computer, your Pull Request will quickly be in the official repository.
Note, that you can not add files online.

Git setup

The next setup can be followed for both linux and windows users, if windows users use the Bash terminal.
Linux users use the terminal.

  1. Navigate to C:/Users/YOURNAME/Documents/Pymol-script-repo OR /home/YOURNAME/Software/pymol/Pymol-script-repo
  2. Right click in folder -> Select: Git Bash
  3. Write in terminal