You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,17 @@
1
-
# How to contribute
1
+
# How to Contribute
2
2
3
3
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.
4
4
5
+
## Getting Started
6
+
7
+
We recommend setting up a local development instance by following these steps:
8
+
1. Install an instance of IRIS (go to https://evaluation.intersystems.com/ for an evaluation kit).
3. Clone a copy of the Embedded Git repository to disk using `git clone`.
11
+
4. Install Embedded Git using IPM by running this terminal command (`zpm "load <path_to_embedded_git_repo_directory> -dev"`).
12
+
5. Configure your Embedded Git instance to point at a Git repository that IS NOT Embedded Git (it can get very messy very quickly).
13
+
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.
14
+
5
15
## Submitting changes
6
16
7
17
If you have made a change that you would like to contribute back to the community, please send a [GitHub Pull Request](/pull/new/main) 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](http://help.github.com/pull-requests/).
@@ -10,17 +20,16 @@ Every pull request should include at least one entry in CHANGELOG.md - see [keep
10
20
11
21
We encourage use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
12
22
13
-
## Coding conventions
23
+
## Coding Conventions
14
24
15
25
Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:
16
26
17
-
*Do not use shortened command and function names. For example, use `set` instead of `s` instead of `set` and `$piece` instead of `$p`
27
+
*Use the full command and function names. For example, use `set` instead of `s` and `$piece` instead of `$p`
18
28
* One command per line
19
-
* Do not use dot syntax
20
29
* Indentation with tabs
21
30
*[Pascal case](https://en.wikipedia.org/wiki/Camel_case) class and method names
22
-
* Avoid using postconditionals
23
-
*Local variables start with `t`; formal parameter names start with `p`
31
+
* Avoid dot syntax
32
+
*Avoid postconditionals
24
33
* Always check %Status return values
25
34
26
35
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).
Copy file name to clipboardExpand all lines: README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,14 +14,13 @@ Embedded Git support for InterSystems platforms, supporting unified source contr
14
14
```
15
15
zpm "install git-source-control"
16
16
```
17
-
To install on an environment without access to the internet, download the tar.gz file from the [releases](https://github.com/intersystems/git-source-control/releases) page. Copy the archive onto a file system the IRIS instance has access to and extract it. Use the package manager to load the release from that directory.
17
+
To install on an environment without access to the internet, download the tar.gz file from the [releases](https://github.com/intersystems/git-source-control/releases) page. Copy it into a directory accessible to the IRIS instance and use a command in the IRIS terminal to install from the tar.gz file.
18
18
```
19
-
tar -xf /path/to/archive/git-source-control-release.tar.gz
2. Configure settings by running the following method and answering the prompts:
23
22
```
24
-
d ##class(SourceControl.Git.API).Configure()
23
+
do ##class(SourceControl.Git.API).Configure()
25
24
```
26
25
This will also allow you to generate an SSH key for use as (e.g.) a deploy key and to initialize or clone a git repo. (If you want to use https instead, please see the documentation [here])(/docs/https.md)
27
26
3. If using VSCode: Set up `isfs` server-side editing. First, save your current workspace in which you have the code open. Then, open the `.code-workspace` file generated by VS Code and add the following to the list of folders:
@@ -155,6 +154,14 @@ Assuming you have the local and remote repositories created,
155
154
### HTTPS Support
156
155
We recommend that people connect to their remote git repository using SSH. If you cannot use SSH connections, we also have support for HTTPS connection through OAuth2. See [our documentation for setting up an https connection](/docs/https.md).
157
156
157
+
## Editing files in the Git repository server-side
158
+
159
+
There are some circumstances where you'll want to edit files in the Git repository on the IRIS server. For example,
160
+
- To edit interoperability system default settings for a different environment
161
+
- To edit custom configuration files
162
+
163
+
Embedded Git allows you to edit files in the Git repository server-side through VS Code. Enable the "Define a namespace-level web application " option by running `do ##class(SourceControl.Git.API).Configure()`. This will automatically create a new IRIS web application for editing files with the VS Code ObjectScript extension. Then go to the Embedded Git Web UI and use the "Code Workspace" option to download a VS Code workspace. The workspace will allow you to edit files in the Git repository on the server.
164
+
158
165
## Support
159
166
160
167
If you find a bug or would like to request an enhancement, [report an issue](https://github.com/intersystems/git-source-control/issues/new). If you have a question, post it on the [InterSystems Developer Community](https://community.intersystems.com/) - consider using the "Git" and "Source Control" tags as appropriate.
0 commit comments