1
1
# Contributing Guidelines
2
2
3
3
Thank you for your interest in contributing to our repository! Whether it's a bug
4
- report, new feature, question, or additional documentation, we greatly value
5
- feedback and contributions from our community. Read through this document
6
- before submitting any issues or pull requests to ensure we have all the
7
- necessary information to effectively respond to your bug report or
8
- contribution.
4
+ report, new feature, or question, we greatly value feedback and contributions from
5
+ our community. Read through this document before submitting any issues or pull
6
+ requests to ensure we have all the necessary information to effectively respond
7
+ to your bug report or contribution.
9
8
10
- In addition to this document, please review our [ Code of
11
- Conduct] ( CODE_OF_CONDUCT.md ) . For any code of conduct questions or comments
12
-
9
+ In addition to this document, review our [ Code of Conduct] ( CODE_OF_CONDUCT.md ) .
10
+ For any code of conduct questions or comments, send an email to
[email protected] .
13
11
14
12
## Reporting Bugs/Feature Requests
15
13
16
14
We welcome you to use the GitHub issue tracker to report bugs or suggest
17
- features. When filing an issue, please check existing open, or recently closed,
18
- issues to make sure somebody else hasn't already reported the issue. Please try
19
- to include as much information as you can. Details like these are incredibly
20
- useful:
15
+ features. When filing an issue, check existing open, or recently closed,
16
+ issues to make sure somebody else hasn't already reported the issue. Try
17
+ to include as much information as you can. Details like these can be useful:
21
18
22
19
- A reproducible test case or series of steps
23
20
- The version of our code being used
24
21
- Any modifications you've made relevant to the bug
25
22
- Anything unusual about your environment or deployment
26
23
- Any known workarounds
27
24
28
- When filing an issue, please do * NOT* include:
25
+ When filing an issue, do * NOT* include:
29
26
30
- - Internal identifiers such as JIRA tickets
27
+ - Internal identifiers such as Jira tickets
31
28
- Any sensitive information related to your environment, users, etc.
32
29
33
- ## Documentation
30
+ ## Reporting Security Issues
34
31
35
- The Splunk Observability documentation is hosted at [ docs.splunk.com] ( https://docs.splunk.com/Observability ) ,
36
- which contains all the prescriptive guidance for Splunk Observability products.
37
- Prescriptive guidance consists of step-by-step instructions, conceptual material,
38
- and decision support for customers. Reference documentation and development
39
- documentation is hosted on this repository.
32
+ See [ SECURITY.md] ( SECURITY.md#reporting-security-issues ) for instructions.
40
33
41
- You can send feedback about Splunk Observability docs by clicking the "Feedback"
42
- button on any of our documentation pages on the official docs site.
34
+ ## Documentation
43
35
44
- ## Reporting Security Issues
36
+ The Splunk Observability documentation is hosted on the [ Splunk Observability
37
+ Cloud docs site] ( https://docs.splunk.com/Observability ) , which contains all the
38
+ prescriptive guidance for Splunk Observability products. Prescriptive guidance
39
+ consists of step-by-step instructions, conceptual material, and decision support
40
+ for customers. Reference documentation and development documentation is still
41
+ hosted on this repository.
45
42
46
- See [ SECURITY.md] ( SECURITY.md#reporting-security-issues ) for detailed instructions.
43
+ To contribute documentation for this project, open a pull request in the
44
+ [ public-o11y-docs] ( https://github.com/splunk/public-o11y-docs ) repository. See
45
+ the [ CONTRIBUTING.md] ( https://github.com/splunk/public-o11y-docs/blob/main/CONTRIBUTING.md )
46
+ guide of the Splunk Observability Cloud documentation for more information.
47
47
48
48
## Contributing via Pull Requests
49
49
50
50
Contributions via Pull Requests (PRs) are much appreciated. Before sending us a
51
- pull request, please ensure that:
51
+ pull request, make sure that:
52
52
53
53
1 . You are working against the latest source on the ` main ` branch.
54
54
2 . You check existing open, and recently merged, pull requests to make sure
@@ -58,10 +58,10 @@ pull request, please ensure that:
58
58
4 . You submit PRs that are easy to review and ideally less 500 lines of code.
59
59
Multiple PRs can be submitted for larger contributions.
60
60
61
- To send us a pull request, please :
61
+ To send us a pull request:
62
62
63
63
1 . Fork the repository.
64
- 2 . Modify the source; please ensure a single change per PR. If you also
64
+ 2 . Modify the source; a single change per PR is recommended . If you also
65
65
reformat all the code, it will be hard for us to focus on your change.
66
66
3 . Ensure local tests pass and add new tests related to the contribution.
67
67
4 . Commit to your fork using clear commit messages.
@@ -118,6 +118,6 @@ $ /usr/bin/safaridriver --enable
118
118
See the [ LICENSE] ( LICENSE ) file for our repository's licensing. We will ask you to
119
119
confirm the licensing of your contribution.
120
120
121
- We may ask you to sign a [ Contributor License Agreement
122
- (CLA) ] ( http://en.wikipedia.org/wiki/Contributor_License_Agreement ) for larger
123
- changes .
121
+ ### Contributor License Agreement
122
+
123
+ Before contributing, you must sign the [ Splunk Contributor License Agreement (CLA) ] ( https://www.splunk.com/en_us/form/contributions.html ) .
0 commit comments