Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

The information below pertains to developers and other coding enthusiasts who would like to set up a running instance of the Open Library Environment project from Github.

Step-by-step guide

  1. Checkout OLE code from github
    1. Create a local workspace where you would want to checkout the OLE codebase
    2. clone the remote repository by issuing the following command: git clone https://github.com/openlibraryenvironment/ole.git
    3. Once its cloned, you will see a folder with the name "ole" created. 
  2. Switch to the appropriate branch
    1. Check which branch is active in your local repository by issuing the following command: git branch -a
      1. One of the listed entries should have an * next to it indicating that is the active branch currently on your local box.
    2. You will need to switch to the "develop" branch. As a best practice, we push our changes to the develop branch.
      1. Issue the following command to switch to the develop branch: git checkout develop
  3. Launch your favorite IDE and start OLE (IntelliJ IDEA instructions- coming soon!)
  4. Ongoing Development
    1. Fork your copy
      1. git clone https://github.com/user/ole.git
    2. Make changes to your local copy
      1. List all the branches by using git checkout -a
      2. Switch to develop branch by using git checkout develop. This is to ensure when pull requests are created, they will be against the develop branch in the main repository.
        1. For more granularity, you can create feature branches and work on those feature branches.
        2. Create a feature branch by using git branch "feature or issue name"
        3. Switch to the new feature branch by using git checkout "feature or issue name"
    3. Push changes to your forked repository
      1. You can work on changes, commit and push the changes to your own public repository. The command to use would be git commit -m "some message" followed by git push origin develop. Alternatively you could you use your favorite IDE to push your changes to your public repository.
    4. Create a pull request
      1. You can visit github.com and go to the ole repository under your username. 
      2. Click on the pull request button to initiate a pull request.
      3. Once a pull request is created, one of the core committers will review and merge the changes to the main line. 
  5. Core Committers
    1. Review pull requests
      1. Direct Diff
      2. Fetch changes locally
        1. Review
        2. Merge
        3. Push

 

  • No labels

Operated as a Community Resource by the Open Library Foundation