GitHub

For collaboration with the ESI standard we are using GitHub.

GitHub is a code hosting platform for version control and collaboration. It lets us work together on the ESI standard from anywhere.

Before we can invite you to the inmation-ESI project we would like to ask you to create a GitHub account and send us your username which you supply when creating this account.

Create a GitHub account over here.

Send us your username.

In the mean time you can learn more about Git by read docs and watch videos over here.

Using GitHub

Accessing the ESI standard can be done using the GitHub portal. The project contains Markdown files, which are the files with the .md extension. GitHub automatically renders them to HTML so that we can read them nicely in the web browser.

Code can be viewed and copied from the web browser and pasted in the code editor of Data Studio.

On GitHub, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes, so other contributors can understand what you’ve done and why.

Make and commit changes

  1. Select the file you want to edit.

  2. Click the pencil icon in the upper right corner of the file view to edit.

  3. In the editor, write your changes.

  4. Write a commit message that describes your changes.

  5. Click Commit changes button.

Open a Pull Request

Pull Requests are the heart of collaboration on GitHub. When you open a pull request, you’re proposing your changes and requesting that we review and pull in your contribution and merge them into ESI standard branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in green and red.

As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.

By using GitHub’s @mention system in your pull request message, you can ask for feedback from specific person or the whole ESI-team.

More guidance can be read here.

Cloning a repository in VS Code

You can clone the inmation-ESI repository with the Git: Clone command in the Command Palette (Ctrl+Shift+P - Windows, Linux) (⇧⌘P - macOS). You will be asked for the URL of the remote repository, which is https://github.com/inmation/inmation-ESI.git, and the parent directory under which to put the local repository.