From c743a5dced2dd68e09ede39e0ef46d047b91aa3c Mon Sep 17 00:00:00 2001 From: James Ranson Date: Tue, 21 Jul 2026 07:48:01 -0600 Subject: [PATCH 1/3] update contributing & readme --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++------------ README.md | 5 ++++- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 831793d..8623f32 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,27 @@ -## Contributing to ThunderCloud - -1. Push your code as a branch in the `sparkmeter` repository. -2. From the GitLab UI, create a new merge request: - * Give it a descriptive title - * Load th the `default` description template (selected from the dropdown below the title input). - * Complete the MR template, ensuring you've completed the checklist - * Items can be checked by replacing `[ ]` with `[x]`. - * All MRs must have a corresponding ticket in Clubhouse. The `[chXXXXXX]` reference must be updated with - the ticket number. -3. Assign the MR to a team member, and ping them on Slack. -4. When approved, rebase and merge your code! +# Contributing + +This project welcomes contributions. If you have a trivial fix or improvement, go ahead and create a pull request with the change. However, if you plan to do something more involved, first file an issue to discuss it with the project maintainers. This will avoid unnecessary work that may not be accepted. + +Should you wish to work on an open, unassigned GitHub Issue, please claim it first by commenting on the issue that you want to work on it and wait for it to be assigned. This prevents duplicated efforts from contributors on the same issue. If you have questions about one of the issues, please leave a comment on it and one of the maintainers will clarify. + +### Steps to Contribute + + * If you have not already, fork the GitHub repository + * Clone your fork (not the base repository) locally + * In your local repository, creating a new branch for your contribution + * Make the desired changes and commit to your branch. Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). + * Push the branch back to your remote fork on GitHub + * Submit a Pull Request to the base repository via GitHub + +### Before Submitting a Pull Request + +Test all contributions locally before submitting Pull Requests by running `./run_tests.sh` from the project root or in a docker container via `docker compose -f docker-compose.test.yml run --rm test`. + +Relevant coding style guidelines are outlined in [CodingStyle.md](CodingStyle.md). You can use [autopep8](https://pypi.org/project/autopep8/) to automatically format your contribution. Ensure contributions are properly formatted before submitting a Pull Request. + + +## Reporting Feature Requests, Bugs and other Issues + +If you find a bug in ThunderCloud, please file a detailed report as a GitHub Issue. We currently do not utilize an Issue template, but please be as thorough as possible in your report. There is no such thing as too much information. + +Likewise, if you have a Feature Request, please file a detailed Issue, explaining the feature's functionality and use cases. New Features should be beneficial to the broader community, so be sure to consider that before filing. diff --git a/README.md b/README.md index d1e270f..a3b4caa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # sparkmeter Also known as ThunderCloud (when deployed to the cloud) or GroundBolt (when deployed to the base station on the ground) + +Note: This software is currently pre-release and is not yet ready for production deployments. + ___ > [!WARNING] @@ -15,7 +18,7 @@ A web application used by utility companies to manage their micro-grids remotely ## Contributing -We accept merge requests! Read the instructions in our [contribution guidelines](/CONTRIBUTING.md) for more details. +We accept pull requests! Read the instructions in our [contribution guidelines](/CONTRIBUTING.md) for more details. ## Flask CLI Commands From 597016cf0bc394092482efafe34e6c9cbd477aad Mon Sep 17 00:00:00 2001 From: James Ranson Date: Tue, 21 Jul 2026 21:01:06 -0600 Subject: [PATCH 2/3] remove redundant message Signed-off-by: James Ranson --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index a3b4caa..2d09a65 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ Also known as ThunderCloud (when deployed to the cloud) or GroundBolt (when deployed to the base station on the ground) -Note: This software is currently pre-release and is not yet ready for production deployments. - ___ > [!WARNING] From 281263dc832e0bcde53d487c294cf7c49471727f Mon Sep 17 00:00:00 2001 From: James Ranson Date: Tue, 21 Jul 2026 21:23:29 -0600 Subject: [PATCH 3/3] fix typos Signed-off-by: James Ranson --- CONTRIBUTING.md | 4 ++-- README.md | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8623f32..4dc4637 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,8 @@ Should you wish to work on an open, unassigned GitHub Issue, please claim it fir * If you have not already, fork the GitHub repository * Clone your fork (not the base repository) locally - * In your local repository, creating a new branch for your contribution - * Make the desired changes and commit to your branch. Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). + * In your local repository, create a new branch for your contribution + * Make the desired changes and commit to your branch. Commits should be as small as possible, while ensuring that each commit is correct independently (e.g., each commit should compile and pass tests). * Push the branch back to your remote fork on GitHub * Submit a Pull Request to the base repository via GitHub diff --git a/README.md b/README.md index 2d09a65..c96ad95 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # sparkmeter Also known as ThunderCloud (when deployed to the cloud) or GroundBolt (when deployed to the base station on the ground) - ___ > [!WARNING]