Update docs

Author: kesmit13

CONTRIBUTING.md

@@ -1,18 +1,46 @@
 # SingleStore Python SDK Contributing Guide
 
 Fork this repo and commit your changes to the forked repo.
-From there make a Pull Request with your submission keeping the following in mind:
+From there make a Pull Request with your submission keeping the
+following in mind:
 
 ## Pre-commit checks on the clone of this repo
 
-The CI pipeline in this repo runs a bunch of validation checks and code reformatting with pre-commit checks. If you don't install those checks in your clone of the repo, the code will likely not pass. To install the pre-commit tool in your clone run the following from your clone directory. This will force the checks before you can push.
+The CI pipeline in this repo runs a bunch of validation checks and code
+reformatting with pre-commit checks. If you don't install those checks
+in your clone of the repo, the code will likely not pass. To install
+the pre-commit tool in your clone run the following from your clone
+directory. This will force the checks before you can push.
 
-```bash
-pip3 install pre-commit==3.7.1
+```
+pip install pre-commit==3.7.1
 pre-commit install
 ```
 
-The checks run automatically when you attempt to commit, but you can run them manually as well with the following:
-```bash
+The checks run automatically when you attempt to commit, but you can run
+them manually as well with the following:
+```
 pre-commit run --all-files
 ```
+
+## Running tests
+
+To create a test environment, do the following:
+```
+pip install -r requirements.txt
+pip install -r test-requirements.txt
+```
+
+If you have Docker installed, you can run the tests as follows. Note that
+you should run the tests using both standard protocol and Data API (HTTP):
+```
+pytest -v singlestoredb/tests
+USE_DATA_API=1 -v singlestoredb/tests
+```
+
+If you need to run against a specific server version, you can specify
+the URL of that server:
+```
+SINGLESTOREDB_URL=user:[email protected]:3306 pytest -v singlestoredb/tests
+SINGLESTOREDB_URL=http://user:[email protected]:8090 pytest -v singlestoredb/tests
+```

RELEASE.md

@@ -1,24 +1,49 @@
 # Release process
 
-1. Bump the version number in `setup.cfg` and `singlestoredb/__init__.py` using
-   semantic versioning rules: minor bump for new features, patch bump for
-   bug fixes.
+## Bump the package version and build documentation
 
-2. Add release notes to `docs/src/whatsnew.rst`.
+Bump the version number in `setup.cfg` and `singlestoredb/__init__.py` using
+semantic versioning rules: minor bump for new features, patch bump for
+bug fixes. Add release notes to `docs/src/whatsnew.rst`. Run `make html` in
+`docs/src` to generate documentation.
 
-3. Run `SINGLESTOREDB_URL=root:@db-server:db-port make html` in `docs/src` to
-   generate documentation. You will need `sphinx` and `sphinx_rtd_theme` installed
-   for this step. You also need a SingleStoreDB server running at the given
-   IP and port to run samples against.
+You will need `sphinx` and `sphinx_rtd_theme` installed for this step. You
+also need a SingleStoreDB server running at the given IP and port to run
+samples against.
 
-4. Commit all changed files with a commit like "Prepare for vX.X.X release".
+There is a utility to do this process for you, but you should check the
+`docs/src/whatsnew.rst` to verify the release summary. Use the following
+to run it:
+```
+resources/bump_version.py < major | minor | patch >
 
-5. The coverage tests will be triggered by the push, but you should also run
-   `Smoke test` workflow manually which does basic tests on all supported versions
-   of Python.
+```
 
-6. Once all workflows are clean, create a new Github release with the name
-   "SingleStoreDB vX.X.X" and set the generated tag to the matching version
-   number. Add the release notes from the `whatsnew.rst` file to the release
-   notes. Creating the release will run the `Public packages` workflow which
-   builds the packages and pubsishes them to PyPI.
+## Commit and push the changes
+
+After verifying the release summary in the documentation, commit the changes:
+```
+# Make sure newly generated docs get added
+git add docs
+
+# Commit changes
+git commit -am "Prepare for vX.X.X release".
+
+git push
+
+```
+
+## Run smoke tests
+
+The coverage tests will be triggered by the push, but you should also run
+[Smoke test](https://github.com/singlestore-labs/singlestoredb-python/actions/workflows/smoke-test.yml)
+workflow manually which does basic tests on all supported versions of Python.
+
+## Create the release on Github
+
+Once all workflows are clean, create a new Github release with the name
+"SingleStoreDB vX.X.X" at <https://github.com/singlestore-labs/singlestoredb-python/releases>
+and set the generated tag to the matching version
+number. Add the release notes from the `whatsnew.rst` file to the release
+notes. Creating the release will run the [Publish packages](https://github.com/singlestore-labs/singlestoredb-python/actions/workflows/publish.yml)
+workflow which builds the packages and pubsishes them to PyPI.