Skip to content

Commit 970b678

Browse files
committed
Update contributing guide with a getting started section
1 parent c476e66 commit 970b678

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
1-
# How to contribute
1+
# How to Contribute
22

33
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.
44

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).
9+
2. Install IPM (InterSystems Package Manager) (https://github.com/intersystems/ipm).
10+
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+
515
## Submitting changes
616

717
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
1020

1121
We encourage use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
1222

13-
## Coding conventions
23+
## Coding Conventions
1424

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

17-
* Do not use shortened command and function names. For example, use `set` instead of `s` 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`
1828
* One command per line
19-
* Do not use dot syntax
2029
* Indentation with tabs
2130
* [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
2433
* Always check %Status return values
2534

2635
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).

0 commit comments

Comments
 (0)