Merge pull request #555 from intersystems/update-readme-tagline-and-support

docs: update tagline and add support statement

Author: isc-tleavitt

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# 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.
+
+## Submitting changes
+
+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/).
+
+Every pull request should include at least one entry in CHANGELOG.md - see [keepachangelog.com](https://keepachangelog.com/) for guidelines.
+
+We encourage use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Coding conventions
+
+Generally speaking, just try to match the conventions you see in the code you are reading. For this project, these include:
+
+* Do not use shortened command and function names - e.g., `s` instead of `set`, `$p` instead of `$piece`
+* One command per line
+* Do not use dot syntax
+* Indentation with tabs
+* Pascal case class and method names
+* Avoid using postconditionals
+* Local variables start with `t`; formal parameter names start with `p`
+* 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!

README.md

@@ -1,5 +1,5 @@
 # git-source-control
- Server-side source control extension for Git on InterSystems' platforms
+Embedded Git support for InterSystems platforms, supporting unified source control for changes made via IDEs (e.g., VSCode over isfs) and the Management Portal (Interoperability and Business Intelligence).
 
 ## Prerequisites/Dependencies
 
@@ -116,8 +116,14 @@ Assuming you have the local and remote repositories created,
    `git config core.sshCommand 'ssh -i ~/.ssh/<private key name>'`
 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.
 
+## Support
 
+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.
 
-## During Development
+## Contributing
+
+Please read [contributing](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
+
+### During Development
 
 :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.