Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (53 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 3.65 KB

How to Contribute

Thank you for your interest in contributing! While this project originated at InterSystems, it is our hope that the community will continue to extend and enhance it.

Getting Started

Developing in Docker Containers

The easiest way to get a working development environment is with Docker. This gives you an IRIS instance with git-source-control pre-installed in development mode.

Prerequisites

Setup

git clone https://github.com/intersystems/git-source-control
cd git-source-control
git checkout -b <new-branch-name>
docker compose up -d --build

This spins up a single container:

  • git-source-control-iris-1: an IRIS instance with git-source-control loaded in dev mode in the USER namespace. The management portal is published to the host at port 52774.

Important Notes

  • The repository is mounted at /home/irisowner/dev/git-source-control/ inside the container.
  • If port 52774 is already in use, edit the port mapping in docker-compose.yml.
  • If you have an InterSystems license key at ~/iris.key, it will be mounted into the container automatically.

Development

Make changes locally and compile them via VS Code. To access the IRIS terminal in the container:

docker compose exec -it iris iris session iris

To run the unit tests from the IRIS terminal:

zpm "git-source-control test -only -verbose"

Developing on an Existing IRIS Instance

If you prefer to use an existing IRIS installation:

  1. Install an instance of IRIS (go to https://evaluation.intersystems.com/ for an evaluation kit).
  2. Install IPM (InterSystems Package Manager) (https://github.com/intersystems/ipm).
  3. Clone a copy of the Embedded Git repository to disk using git clone.
  4. Install Embedded Git using IPM by running this terminal command (zpm "load <path_to_embedded_git_repo_directory> -dev").
  5. Configure your Embedded Git instance to point at a Git repository that IS NOT Embedded Git (it can get very messy very quickly).
  6. Modify the code locally! Note that any changes to CSP pages will require loading the module again with IPM to propagate the changes to your local instance.

Submitting changes

If you have made a change that you would like to contribute back to the community, please send a GitHub Pull Request explaining it. If your change fixes an issue that you or another user reported, please mention it in the pull request. You can find out more about pull requests here.

Every pull request should include at least one entry in CHANGELOG.md - see keepachangelog.com for guidelines.

We encourage use of Conventional Commits.

Coding Conventions

Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:

  • Use the full command and function names. For example, use set instead of s and $piece instead of $p
  • One command per line
  • Indentation with tabs
  • Pascal case class and method names
  • Avoid dot syntax
  • Avoid postconditionals
  • Always check %Status return values

When making changes that involve JavaScript, ensure that your changes still work from Studio (which uses an old version of IE under the hood and therefore doesn't support various things you might take for granted).

Thank you!