From 8b6ea1189a45180663cfc822af33a0a99203b888 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Tue, 10 Oct 2023 07:01:32 +0200 Subject: [PATCH 1/3] Update required files based on gdi-spec 1.6.0 --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 58 ++++++++++++++++++++++++++++------------------ LICENSE | 1 - SECURITY.md | 3 +-- 4 files changed, 37 insertions(+), 27 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index a380102a..072da1ef 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,7 +60,7 @@ project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at splunk-oss-admin@splunk.com. All +reported by contacting the project team at . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 944d8492..cc4ea97d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,20 @@ # Contributing Guidelines Thank you for your interest in contributing to our repository! Whether it's a bug -report, new feature, question, or additional documentation, we greatly value -feedback and contributions from our community. Read through this document -before submitting any issues or pull requests to ensure we have all the -necessary information to effectively respond to your bug report or -contribution. +report, new feature, or question, we greatly value feedback and contributions from +our community. Read through this document before submitting any issues or pull +requests to ensure we have all the necessary information to effectively respond +to your bug report or contribution. -In addition to this document, please review our [Code of -Conduct](CODE_OF_CONDUCT.md). For any code of conduct questions or comments -please email oss@splunk.com. +In addition to this document, review our [Code of Conduct](CODE_OF_CONDUCT.md). +For any code of conduct questions or comments, send an email to . ## Reporting Bugs/Feature Requests We welcome you to use the GitHub issue tracker to report bugs or suggest -features. When filing an issue, please check existing open, or recently closed, -issues to make sure somebody else hasn't already reported the issue. Please try -to include as much information as you can. Details like these are incredibly -useful: +features. When filing an issue, check existing open, or recently closed, +issues to make sure somebody else hasn't already reported the issue. Try +to include as much information as you can. Details like these can be useful: - A reproducible test case or series of steps - The version of our code being used @@ -25,19 +22,33 @@ useful: - Anything unusual about your environment or deployment - Any known workarounds -When filing an issue, please do *NOT* include: +When filing an issue, do *NOT* include: -- Internal identifiers such as JIRA tickets +- Internal identifiers such as Jira tickets - Any sensitive information related to your environment, users, etc. ## Reporting Security Issues -See [SECURITY.md](SECURITY.md#reporting-security-issues) for detailed instructions. +See [SECURITY.md](SECURITY.md#reporting-security-issues) for instructions. + +## Documentation + +The Splunk Observability documentation is hosted on the [Splunk Observability +Cloud docs site](https://docs.splunk.com/Observability), which contains all the +prescriptive guidance for Splunk Observability products. Prescriptive guidance +consists of step-by-step instructions, conceptual material, and decision support +for customers. Reference documentation and development documentation is still +hosted on this repository. + +To contribute documentation for this project, open a pull request in the +[public-o11y-docs](https://github.com/splunk/public-o11y-docs) repository. See +the [CONTRIBUTING.md](https://github.com/splunk/public-o11y-docs/blob/main/CONTRIBUTING.md) +guide of the Splunk Observability Cloud documentation for more information. ## Contributing via Pull Requests Contributions via Pull Requests (PRs) are much appreciated. Before sending us a -pull request, please ensure that: +pull request, make sure that: 1. You are working against the latest source on the `main` branch. 2. You check existing open, and recently merged, pull requests to make sure @@ -46,18 +57,18 @@ pull request, please ensure that: time to be wasted. 4. You submit PRs that are easy to review and ideally less 500 lines of code. Multiple PRs can be submitted for larger contributions. -5. Set up commit signing. Unsigned commits will not be accepted. -To send us a pull request, please: +To send us a pull request: 1. Fork the repository. -2. Modify the source; please ensure a single change per PR. If you also +2. Modify the source; a single change per PR is recommended. If you also reformat all the code, it will be hard for us to focus on your change. 3. Ensure local tests pass and add new tests related to the contribution. 4. Commit to your fork using clear commit messages. -5. Send us a pull request, answering any default questions in the pull request +5. [Sign your commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). +6. Send us a pull request, answering any default questions in the pull request interface. -6. Pay attention to any automated CI failures reported in the pull request, and +7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. GitHub provides additional documentation on [forking a @@ -76,5 +87,6 @@ any 'help wanted' issues is a great place to start. See the [LICENSE](LICENSE) file for our repository's licensing. We will ask you to confirm the licensing of your contribution. -All contributors must execute the [Splunk Contributor License Agreement -(CLA) form](https://www.splunk.com/en_us/form/contributions.html). +### Contributor License Agreement + +Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html). diff --git a/LICENSE b/LICENSE index 57bc88a1..261eeb9e 100644 --- a/LICENSE +++ b/LICENSE @@ -199,4 +199,3 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - diff --git a/SECURITY.md b/SECURITY.md index b6b5f162..3662376b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -3,5 +3,4 @@ ## Reporting Security Issues Please *DO NOT* report security vulnerabilities with public GitHub issue -reports. Please [report security issues here]( -https://www.splunk.com/en_us/product-security/report.html). +reports. Please [report security issues here](https://www.splunk.com/en_us/product-security/report.html). From 8e2ba6b5d91e1b94dea2caff8d09f33e3cb76eb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Tue, 10 Oct 2023 07:05:22 +0200 Subject: [PATCH 2/3] Update CODEOWNERS for gdi-spec --- .github/CODEOWNERS | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d0231f85..c19ba331 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,9 @@ -* @signalfx/gdi-ios-maintainers +# https://help.github.com/en/articles/about-code-owners +# +# Global Owners +* @signalfx/gdi-ios-maintainers @signalfx/gdi-ios-approvers + +.github/CODEOWNERS @signalfx/gdi-ios-maintainers ##################################################### # @@ -6,7 +11,7 @@ # ##################################################### -*.md @signalfx/gdi-docs @signalfx/gdi-ios-maintainers -*.rst @signalfx/gdi-docs @signalfx/gdi-ios-maintainers -docs/ @signalfx/gdi-docs @signalfx/gdi-ios-maintainers -README* @signalfx/gdi-docs @signalfx/gdi-ios-maintainers +*.md @signalfx/gdi-ios-maintainers @signalfx/gdi-ios-approvers @signalfx/gdi-docs +*.rst @signalfx/gdi-ios-maintainers @signalfx/gdi-ios-approvers @signalfx/gdi-docs +docs/ @signalfx/gdi-ios-maintainers @signalfx/gdi-ios-approvers @signalfx/gdi-docs +README* @signalfx/gdi-ios-maintainers @signalfx/gdi-ios-approvers @signalfx/gdi-docs From f0fdb29a21dab4f8af6168b522c0e00c11973f1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Tue, 10 Oct 2023 07:15:24 +0200 Subject: [PATCH 3/3] Adjust CHANGELOG to Keep a changelog --- CHANGELOG.md | 40 +++++++++++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c18797e..2e2a6ecc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,16 +5,46 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## Version 0.11.2 -* Fixes adding a link to a network span if traceparent is not the first key in the string +## [Unreleased](https://github.com/signalfx/splunk-otel-ios/compare/0.11.2...HEAD) + +### Added + +### Changed + +#### Dependency updates + +### Deprecated + +### Removed + +### Fixed + +### Security + +## [0.11.2](https://github.com/signalfx/splunk-otel-ios/releases/tag/0.11.2) + +### Added + * Implement Sampler protocol for SessionBasedSampler -## Version 0.11.1 +### Fixed + +* Fixes adding a link to a network span if traceparent is not the first key in the string + +## [0.11.1](https://github.com/signalfx/splunk-otel-ios/releases/tag/0.11.1) + +### Added + * Adds option for slowRenderingDetectionEnabled * Adds option for bspScheduleDelay -## Version 0.11.0 +## [0.11.0](https://github.com/signalfx/splunk-otel-ios/releases/tag/0.11.0) + +### Added -* Deprecates the use of SplunkRum.initialize. Use the SplunkRumBuilder going forward. * Adds reportEvent convenience function. * Adds ability to import project through cocoapods. + +### Deprecated + +* Deprecates the use of SplunkRum.initialize. Use the SplunkRumBuilder going forward.