Skip to content

Conversation

@sbernabe1
Copy link
Contributor

Updating git clone command to clone appropriate Repo

Adding Reviewer:
@synqotik

Updating git clone command to clone appropriate Repo
@github-actions github-actions bot added the docs label Sep 16, 2025
@sonarqubecloud
Copy link

Copy link
Contributor

@synqotik synqotik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking the developer should just clone the whole repo, then switch to the branch they need to work on, see my comment.

Eventually developers may work off of v9 or v12 branches.

+
[source, shell]
git clone https://github.com/OpenNMS/grafana-plugin.git opennms-grafana-plugin
git clone --branch release-9.x https://github.com/OpenNMS/grafana-plugin.git opennms-grafana-plugin
Copy link
Contributor

@synqotik synqotik Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to change this to something like:

. Use Git to check out the repository:
+
[source, shell]
git clone https://github.com/OpenNMS/grafana-plugin.git opennms-grafana-plugin

. Navigate to your plugin directory:
+
[source, shell]
cd opennnms-grafana-plugin

. Switch to the branch you want to work on. For OPG compatible with Grafana 9-11, you should work in the `release-9.x` branch:
+
[source, shell]
git branch release-9.x
git pull

. If you plan on making changes or making a PR, you should make a branch off of the main release branch:
+
[source, shell]
git checkout -b myusername/my-feature-name

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants