Skip to content

Commit 3bbd2ba

Browse files
committed
docs: support goes further down; add CONTRIBUTING
1 parent 7569144 commit 3bbd2ba

File tree

2 files changed

+37
-5
lines changed

2 files changed

+37
-5
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to contribute
2+
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+
5+
## Submitting changes
6+
7+
If you have made a change that you would like to contribute back to the community, please send a [GitHub Pull Request](/pull/new/master) 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/).
8+
9+
Every pull request should include at least one entry in CHANGELOG.md - see [keepachangelog.com](https://keepachangelog.com/) for guidelines.
10+
11+
We encourage use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
12+
13+
## Coding conventions
14+
15+
Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:
16+
17+
* Do not use shortened command and function names - e.g., `s` instead of `set`, `$p` instead of `$piece`
18+
* One command per line
19+
* Do not use dot syntax
20+
* Indentation with tabs
21+
* Pascal case class and method names
22+
* Avoid using postconditionals
23+
* Local variables start with `t`; formal parameter names start with `p`
24+
* Always check %Status return values
25+
26+
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).
27+
28+
Thank you!

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Embedded Git support for InterSystems platforms, supporting unified source contr
88
* OpenSSH 7.6+
99
* InterSystems package manager (https://openexchange.intersystems.com/package/ObjectScript-Package-Manager)
1010

11-
## Support
12-
13-
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.
14-
1511
## Installation and Setup
1612

1713
1. Load this repository into IRIS from the community package registry.
@@ -120,6 +116,14 @@ Assuming you have the local and remote repositories created,
120116
`git config core.sshCommand 'ssh -i ~/.ssh/<private key name>'`
121117
8. Test the refresh button for the remote branches on the WebUI, fetch from the source control menu in Studio or VS Code, and `git fetch` in Git Bash. All 3 should work without any issues.
122118
123-
## During Development
119+
## Support
120+
121+
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.
122+
123+
## Contributing
124+
125+
Please read [contributing](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
126+
127+
### During Development
124128
125129
:warning: Whenever any code in this project is updated outside the server (e.g. after every `git pull`), you _have_ to run `zpm "load <absolute path to git-source-control>"`. Otherwise, the changes won't be reflected on the server. However, if you load git-source-control via the InterSystems package manager and run `git pull` via the extension itself with the default pull event handler configured, it'll just work.

0 commit comments

Comments
 (0)