From a9a6466d5ae1e62bca557f4663ce77b689e7c655 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Sat, 13 Feb 2021 19:43:21 -0500 Subject: [PATCH] Add security doc link to README (#2487) Move contributing doc within Getting Involved link. Depends on #2461 --- CONTRIBUTING.md | 38 +++++++++++++++++++++++++------------- README.md | 6 +++--- 2 files changed, 28 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 318217c7403..dad9662f9b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,37 @@ # Contributing Guide -We'd love your help! +We'd love your help! Please join our weekly [SIG +meeting](https://github.com/open-telemetry/community#special-interest-groups). ## How to structure PRs to get expedient reviews? -We recommend that any PR (unless it is trivial) to be smaller than 500 lines (excluding go mod/sum changes) in order to help reviewers to do a thorough and reasonably fast reviews. +We recommend that any PR (unless it is trivial) to be smaller than 500 lines +(excluding go mod/sum changes) in order to help reviewers to do a thorough and +reasonably fast reviews. ### When adding a new component -Consider submitting different PRs for (more details about adding new components [here](#adding-new-components)) : +Consider submitting different PRs for (more details about adding new components +[here](#adding-new-components)) : * First PR should include the overall structure of the new component: - * Readme, configuration, and factory implementation usually using the helper factory structs. - * This PR is usually trivial to review, so the size limit does not apply to it. -* Second PR should include the concrete implementation of the component. -If the size of this PR is larger than the recommended size consider splitting it in multiple PRs. -* Last PR should enable the new component and add it to the `otelcontribcol` binary by updating the `components.go` file. -The component must be enabled only after sufficient testing, and there is enough confidence in the stability and quality of the component. + * Readme, configuration, and factory implementation usually using the helper + factory structs. + * This PR is usually trivial to review, so the size limit does not apply to + it. +* Second PR should include the concrete implementation of the component. If the + size of this PR is larger than the recommended size consider splitting it in + multiple PRs. +* Last PR should enable the new component and add it to the `otelcontribcol` + binary by updating the `components.go` file. The component must be enabled + only after sufficient testing, and there is enough confidence in the + stability and quality of the component. ### Refactoring Work -Any refactoring work must be split in its own PR that does not include any behavior changes. -It is important to do this to avoid hidden changes in large and trivial refactoring PRs. +Any refactoring work must be split in its own PR that does not include any +behavior changes. It is important to do this to avoid hidden changes in large +and trivial refactoring PRs. ## Report a bug or requesting feature @@ -74,7 +84,8 @@ Verify that the upstream exists: `git remote -v` -To update your fork, fetch the upstream repo's branches and commits, then merge your `main` with upstream's `main`: +To update your fork, fetch the upstream repo's branches and commits, then merge +your `main` with upstream's `main`: ``` git fetch upstream @@ -120,7 +131,8 @@ $ make install-tools # Only first time. $ make ``` -*Note:* the default build target requires tools that are installed at `$(go env GOPATH)/bin`, ensure that `$(go env GOPATH)/bin` is included in your `PATH`. +*Note:* the default build target requires tools that are installed at `$(go env +GOPATH)/bin`, ensure that `$(go env GOPATH)/bin` is included in your `PATH`. ## Creating a PR diff --git a/README.md b/README.md index 4f29066c433..38bcd5fbda6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Getting Started   •   - Getting Involved + Getting Involved   •   Getting In Touch @@ -28,8 +28,6 @@

- Contributing -   •   Vision   •   Design @@ -38,6 +36,8 @@   •   Performance   •   + Security +   •   Roadmap