Skip to content

Commit

Permalink
Add security doc link to README (#2487)
Browse files Browse the repository at this point in the history
Move contributing doc within Getting Involved link.

Depends on #2461
  • Loading branch information
flands committed Feb 14, 2021
1 parent 05d7f38 commit a9a6466
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 16 deletions.
38 changes: 25 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<strong>
<a href="https://opentelemetry.io/docs/collector/getting-started/">Getting Started<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://github.com/open-telemetry/community#special-interest-groups">Getting Involved<a/>
<a href="CONTRIBUTING.md">Getting Involved<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://gitter.im/open-telemetry/opentelemetry-service">Getting In Touch<a/>
</strong>
Expand All @@ -28,8 +28,6 @@

<p align="center">
<strong>
<a href="CONTRIBUTING.md">Contributing<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/vision.md">Vision<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/design.md">Design<a/>
Expand All @@ -38,6 +36,8 @@
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/performance.md">Performance<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/security.md">Security<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/roadmap.md">Roadmap<a/>
</strong>
</p>
Expand Down

0 comments on commit a9a6466

Please sign in to comment.