Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore]Update CONTRIBUTING.md for public, new signalfx project member, and current signalfx project members #1639

Merged
merged 1 commit into from
Apr 11, 2025

Conversation

jvoravong
Copy link
Contributor

@jvoravong jvoravong commented Jan 30, 2025

Description: More documentation for contributors!

@jvoravong jvoravong requested review from a team as code owners January 30, 2025 17:10
Multiple PRs can be submitted for larger contributions.
### Case 1: Public Contributors (No Connection to SignalFX Organization)

As a **public contributor** with no relation to SignalFX organization, you will likely **not have permission to create a feature branch** in the SignalFX repository. Here’s what to do:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
As a **public contributor** with no relation to SignalFX organization, you will likely **not have permission to create a feature branch** in the SignalFX repository. Here’s what to do:
As a **public contributor** with no relation to Signalfx github organization, you will likely **not have permission to create a feature branch** in this repository. Here’s what to do:

We are referring to the github org here right? I think we should use Cisco/Splunk other wise

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • I mean the signalfx github org, I'm trying to be concise with wording here and elsewhere. Let me take another stab at it.
  • I would like to hold off on introducing "Cisco" language until a separate PR where we can update the documentation in the whole repo in a single PR.

@jvoravong
Copy link
Contributor Author

In addition to the docs changes here, I'm going to add a test (in pre-commit?) to validate people submit PRs properly to this repo. If the test fails it will point them to these new docs.

@jvoravong jvoravong merged commit d9ff3c9 into main Apr 11, 2025
64 of 65 checks passed
@jvoravong jvoravong deleted the contributing-doc branch April 11, 2025 14:50
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants