You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
8
+
permissions:
9
+
actions: write
10
+
contents: write
11
+
pull-requests: write
12
+
statuses: write
13
+
jobs:
14
+
CLAAssistant:
15
+
runs-on: ubuntu-latest
16
+
steps:
17
+
- name: "CLA Assistant"
18
+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
19
+
uses: contributor-assistant/github-action@v2.3.0
20
+
env:
21
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22
+
# the below token should have repo scope and must be manually added by you in the repository's secret
23
+
# This token is required only if you have configured to store the signatures in a remote repository/organization
path-to-document: 'https://github.com/splunk/cla-agreement/blob/main/CLA.md'# e.g. a CLA or a DCO document
28
+
# branch should not be protected
29
+
branch: 'main'
30
+
allowlist: dependabot[bot]
31
+
remote-organization-name: splunk
32
+
remote-repository-name: cla-agreement
33
+
CodeOfConduct:
34
+
runs-on: ubuntu-latest
35
+
steps:
36
+
- name: "COC Assistant"
37
+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the Code of Conduct and I hereby accept the Terms') || github.event_name == 'pull_request_target'
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+7-12
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ If you are reporting a bug or issues, please include:
13
13
14
14
- Operating system name and version.
15
15
- Any details about your local setup that might be helpful
16
-
in troubleshooting (E.G. Python version if using a python script, Terraform version if you're using a Terraform script.).
16
+
in troubleshooting
17
17
- Detailed steps to reproduce the bug.
18
18
19
19
### Fix Bugs
@@ -23,17 +23,16 @@ a "bug" ticket type is open to whoever wants to implement it.
23
23
24
24
### Implement Features
25
25
26
-
If you have a great set of dashboards, detectors, API scripts for sending metrics, or any other content
27
-
you believe will be of use to others, please contribute it!
28
-
29
-
Or check the Issues for this repo on GitHub. Anything tagged with "enhancement"
26
+
Please file an issue or check the issues for this repo on GitHub. Anything tagged with "enhancement"
30
27
and "help wanted" is open to whoever wants to implement it.
31
28
29
+
Once issues are posted and triaged please include their issue number in any PRs related to that work
30
+
32
31
### Write Documentation
33
32
34
33
Submissions and `README.md` files could always use more documentation. Documentation can always use an update or tweak in the official docs, in docstrings of scripts, comments in configs, or anywhere a bit of clarity may be useful..
35
34
36
-
### Submit Feedback
35
+
### Submit Issues / Feedback
37
36
38
37
If you are proposing a feature:
39
38
@@ -47,9 +46,5 @@ If you are proposing a feature:
47
46
48
47
Before you submit a pull request, check that it meets these guidelines:
49
48
50
-
1. The pull request should include a `README.md` for any new submission.
51
-
2. If the pull request adds functionality, the `README.md` docs for that component or submission should be updated.
52
-
Put your new functionality into a function with a docstring, and add
53
-
the feature to the list in README.md.
54
-
3. Terraform submissions should work with the most current version of the included Terraform Provider.
55
-
4. Python submissions should work for Python3
49
+
1. The pull request should include documentation and example changes for any new functionality.
50
+
2. If the pull request adds functionality, the tests should be updated.
Copy file name to clipboardexpand all lines: README.md
+21-2
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# syntheticsclient
2
-
A Splunk Synthetics (Formerly Rigor) client for golang.
2
+
A Splunk Synthetics for Splunk Observability (Formerly Rigor) client for golang.
3
3
4
4
## Installation
5
5
`go get https://github.com/splunk/syntheticsclient.git`
@@ -52,4 +52,23 @@ func main() {
52
52
API Docs are [available here](https://dev.splunk.com/observability/reference)
53
53
54
54
## Additional Information
55
-
This client is largely a copypasta mutation of the [go-victor](https://github.com/victorops/go-victorops) client for Splunk On-Call (formerly known as VictorOps).
55
+
This client is largely a copypasta mutation of the [go-victor](https://github.com/victorops/go-victorops) client for Splunk On-Call (formerly known as VictorOps).
56
+
57
+
## Contributions
58
+
Contributions are welcome and encouraged!
59
+
60
+
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details on contributing to this repository.
61
+
62
+
Before your contribution can be accepted, you will be asked to sign our
0 commit comments