Skip to content

Commit 614c75a

Browse files
authored
Update contributing.md to match template (#618)
1 parent 5e3bec0 commit 614c75a

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

CONTRIBUTING.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
11
# Contributing Guidelines
22

33
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.
98

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-
please email [email protected].
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].
1311

1412
## Reporting Bugs/Feature Requests
1513

1614
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:
2118

2219
- A reproducible test case or series of steps
2320
- The version of our code being used
2421
- Any modifications you've made relevant to the bug
2522
- Anything unusual about your environment or deployment
2623
- Any known workarounds
2724

28-
When filing an issue, please do *NOT* include:
25+
When filing an issue, do *NOT* include:
2926

30-
- Internal identifiers such as JIRA tickets
27+
- Internal identifiers such as Jira tickets
3128
- Any sensitive information related to your environment, users, etc.
3229

33-
## Documentation
30+
## Reporting Security Issues
3431

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.
4033

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
4335

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.
4542

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.
4747

4848
## Contributing via Pull Requests
4949

5050
Contributions via Pull Requests (PRs) are much appreciated. Before sending us a
51-
pull request, please ensure that:
51+
pull request, make sure that:
5252

5353
1. You are working against the latest source on the `main` branch.
5454
2. You check existing open, and recently merged, pull requests to make sure
@@ -58,10 +58,10 @@ pull request, please ensure that:
5858
4. You submit PRs that are easy to review and ideally less 500 lines of code.
5959
Multiple PRs can be submitted for larger contributions.
6060

61-
To send us a pull request, please:
61+
To send us a pull request:
6262

6363
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
6565
reformat all the code, it will be hard for us to focus on your change.
6666
3. Ensure local tests pass and add new tests related to the contribution.
6767
4. Commit to your fork using clear commit messages.
@@ -118,6 +118,6 @@ $ /usr/bin/safaridriver --enable
118118
See the [LICENSE](LICENSE) file for our repository's licensing. We will ask you to
119119
confirm the licensing of your contribution.
120120

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

Comments
 (0)