Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add style guide and basic contribution section #3651

Merged
merged 74 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
7491948
Create folder and index
theletterf Dec 5, 2023
343d140
Initial structure and index
theletterf Dec 5, 2023
000105f
Main contribution guide
theletterf Dec 5, 2023
9812ebe
Blog post guide
theletterf Dec 5, 2023
22cb3ee
Cleanup
theletterf Dec 5, 2023
cecf2ab
Edits
theletterf Dec 11, 2023
ff92f51
Merge branch 'main' into theletterf-add-style-guide
theletterf Dec 11, 2023
fee4daf
Fix errors
theletterf Dec 11, 2023
2284214
More fixes
theletterf Dec 11, 2023
7b004b0
Fix linter issues
theletterf Dec 12, 2023
040fe94
Fix terminology error
theletterf Dec 12, 2023
83cd540
Linter fixes
theletterf Dec 12, 2023
95c6abf
Merge branch 'main' into theletterf-add-style-guide
theletterf Dec 12, 2023
f4a2354
Update content/en/docs/Contribute/_index.md
theletterf Dec 13, 2023
74ac067
Update content/en/docs/Contribute/_index.md
theletterf Dec 13, 2023
25ecb76
Update content/en/docs/Contribute/_index.md
theletterf Dec 13, 2023
6bfac8b
Edit
theletterf Dec 13, 2023
1bf3ae5
Merge branch 'theletterf-add-style-guide' of github.com:open-telemetr…
theletterf Dec 13, 2023
36cede9
Change casing
theletterf Dec 13, 2023
c9199c6
Halfway peer edits
theletterf Dec 13, 2023
143f434
Merge branch 'main' into theletterf-add-style-guide
theletterf Dec 13, 2023
c66b579
Further edits
theletterf Dec 13, 2023
ccdc722
Merge branch 'theletterf-add-style-guide' of github.com:open-telemetr…
theletterf Dec 13, 2023
fdc5b29
Glossary entries
theletterf Dec 13, 2023
23db51d
Final edits
theletterf Dec 13, 2023
6478ee2
Edit
theletterf Dec 13, 2023
747515d
Update content/en/docs/contribute/_index.md
theletterf Dec 14, 2023
ca73cf2
Merge branch 'main' into theletterf-add-style-guide
theletterf Dec 14, 2023
e23192b
Results from /fix:format
opentelemetrybot Dec 14, 2023
8199e71
Merge branch 'main' into theletterf-add-style-guide
theletterf Dec 18, 2023
126fc4f
Create folder and index
theletterf Dec 5, 2023
4e3bc13
Initial structure and index
theletterf Dec 5, 2023
a2c04d2
Main contribution guide
theletterf Dec 5, 2023
e5cb9cb
Blog post guide
theletterf Dec 5, 2023
e6cc3db
Cleanup
theletterf Dec 5, 2023
78e3220
Edits
theletterf Dec 11, 2023
3fa6bd4
Fix errors
theletterf Dec 11, 2023
d7094aa
More fixes
theletterf Dec 11, 2023
f1e63e1
Fix linter issues
theletterf Dec 12, 2023
8cecc7c
Fix terminology error
theletterf Dec 12, 2023
8c7d12d
Linter fixes
theletterf Dec 12, 2023
c45b842
Update content/en/docs/Contribute/_index.md
theletterf Dec 13, 2023
fc668d7
Update content/en/docs/Contribute/_index.md
theletterf Dec 13, 2023
3f6f2c3
Update content/en/docs/Contribute/_index.md
theletterf Dec 13, 2023
b6ec84a
Edit
theletterf Dec 13, 2023
8bf2c9c
Change casing
theletterf Dec 13, 2023
a147bdb
Halfway peer edits
theletterf Dec 13, 2023
7eb076d
Further edits
theletterf Dec 13, 2023
c756a04
Glossary entries
theletterf Dec 13, 2023
59721c9
Final edits
theletterf Dec 13, 2023
c39c59f
Edit
theletterf Dec 13, 2023
856072e
Update content/en/docs/contribute/_index.md
theletterf Dec 14, 2023
1e0138b
Results from /fix:format
opentelemetrybot Dec 14, 2023
ef56302
Update content/en/docs/contribute/style-guide.md
theletterf Jan 10, 2024
01acb2c
Update content/en/docs/contribute/_index.md
theletterf Jan 10, 2024
a34cef7
Update content/en/docs/contribute/blogs-case-studies.md
theletterf Jan 10, 2024
6d88a72
Update content/en/docs/contribute/_index.md
theletterf Jan 10, 2024
c9a5d8d
Update content/en/docs/contribute/blogs-case-studies.md
theletterf Jan 10, 2024
cd90896
Update content/en/docs/contribute/blogs-case-studies.md
theletterf Jan 10, 2024
b05a704
Update content/en/docs/contribute/_index.md
theletterf Jan 10, 2024
2215445
Update content/en/docs/contribute/_index.md
theletterf Jan 10, 2024
08a2a8c
Merge branch 'theletterf-add-style-guide' of github.com:open-telemetr…
theletterf Jan 10, 2024
2222315
Rename section
theletterf Jan 10, 2024
02c2322
Merge branch 'main' into theletterf-add-style-guide
theletterf Jan 10, 2024
4ca9786
Edit README
theletterf Jan 10, 2024
050089b
Final edits
theletterf Jan 10, 2024
2987345
Fixes
theletterf Jan 11, 2024
e33105c
Merge branch 'main' into theletterf-add-style-guide
theletterf Jan 11, 2024
daa14cb
Merge branch 'main' into theletterf-add-style-guide
theletterf Jan 11, 2024
f4d2677
Remove HTML test
theletterf Jan 11, 2024
7acc40e
Updated refcache
theletterf Jan 11, 2024
ba1ee0d
Merge branch 'main' into theletterf-add-style-guide
theletterf Jan 11, 2024
61fe8d8
Fix refcache
theletterf Jan 11, 2024
5a61710
Fix period
theletterf Jan 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 42 additions & 125 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,53 @@
# Contributing to OpenTelemetry.io

Thanks for your interest in contributing to
[OpenTelemetry.io](https://opentelemetry.io/)! Here are a few general guidelines
on contributing and reporting bugs that we ask you to review. Following these
guidelines helps to communicate that you respect the time of the contributors
managing and developing this open source project. In return, they should
reciprocate that respect in addressing your issue, assessing changes, and
helping you finalize your pull requests. In that spirit of mutual respect, we
endeavor to review incoming issues and pull requests, and will close any
lingering issues or pull requests after long times of inactivity.

Note that all of your interactions in the project are subject to our
[Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md).
This includes creation of issues or pull requests, commenting on issues or pull
requests, and extends to all interactions in any real-time space e.g., Slack,
Discord, etc.

Also review the general
**Thanks for your interest in contributing to
[OpenTelemetry.io](https://opentelemetry.io/)!**

Follow these guidelines helps to communicate that you respect the time of the
contributors managing and developing this open source project. In return,
maintainers and approvers should reciprocate that respect in addressing your
issue, assessing changes, and helping you finalize your pull requests. In that
spirit of mutual respect, we endeavor to review incoming issues and pull
requests, and will close any lingering issues or pull requests after long times
of inactivity.

## Before you get started

### Code of Conduct

All of your interactions in this project are subject to our
[Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md)
. This includes the creation of issues or pull requests, commenting on issues or
theletterf marked this conversation as resolved.
Show resolved Hide resolved
pull requests, and extends to all interactions in any real-time space, for
example Slack, Discord, and so on.

### Contributor License Agreement

Review the general
[OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md),
that will provide additional details, especially that you need to sign a
as it provides additional details, especially that you need to sign a
Contributor License Agreement (CLA) before you can contribute.

## Found a security issue?
### Found a security issue?

If you discover a security issue, **do not** report it through GitHub. Instead,
follow the steps in our
[Security Policy](https://github.com/open-telemetry/opentelemetry.io/security/policy).
If you discover a security issue, read the
[Security Policy](https://github.com/open-telemetry/opentelemetry.io/security/policy)
before opening an issue.

## Found a problem?
### Found a problem?

If you find a problem with the content of this repository, or you would like to
request an enhancement, [create an issue][new-issue].
If you find a bug or a problem with the content of this repository, or you would
like to request an enhancement, [create an issue][new-issue].

Before reporting a new issue, please ensure that the issue was not already
reported or fixed by searching through our
Before reporting a new issue, make sure that the issue was not already reported
or fixed by searching through our
[issues list](https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).

When creating a new issue, include a short meaningful title and clear a
description, as much relevant information as possible, and, if possible, a test
case.
When creating a new issue, include a short, meaningful title and a clear
description. Add as much relevant information as you can, and, if possible, a
test case.

## Want to work on an existing issue?
### Want to work on an existing issue?

This is the best way how you can help us to make our documentation better! Take
a look at issues tagged with
Expand All @@ -59,64 +66,11 @@ non-community members who have already made contributions to the [OpenTelemetry
organization][org]. After confirmation through a maintainer, plan to provide a
PR shortly or let maintainers now if you run into any blockers.

## Sending Pull Requests

Enhancements and fixes to the website are most welcome!

Before sending a new [pull request][pr] (PR), take a look at existing
[pull requests](https://github.com/open-telemetry/opentelemetry.io/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
and
[issues](https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
to see if the proposed change or fix has been discussed in the past, or if the
change was already implemented but not yet released.

### Quick fixes

For small changes to a single file, you can edit directly in GitHub by clicking
**Edit this file** button. After forking the repository, follow the instructions
in [Editing files][].

However, formatting may still be needed, like reducing line lengths in the
edited file. The options for fixing formatting are:

- Checking out the project and running the CLI scripts mentioned in
[Submitting a change](#submitting-a-change).
- Commenting `/fix:format` on your pull request to trigger an automated script.
This requires a unique branch name, which can be edited under _View all
branches_ in your fork.

For larger fixes, follow the
[instructions to setup a development environment](#development) below.

### PR Guidelines

Before a PR gets merged, it will sometimes require a few iterations of
review-and-edit. To help us and yourself make this process as easy as possible,
we ask that adhere to the following:

- If your PR isn't a [quick fix](#quick-fixes), then **work from a fork**: Click
the [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) button at
the top of the repository and clone the fork locally. When you are ready,
raise a PR with the upstream repository.
- **Do not work from the `main`** branch of your fork, but create a PR-specific
branch.
- Ensure that maintainers are
[allowed to apply changes to your pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
## Contributor's guide

### Merge requirements

- No “changes requested” reviews by approvers, maintainers, technical committee
members, or subject matter experts
- No unresolved conversations
- Approved by at least one approver
- No failing PR checks
- PR branch is up-to-date with the base branch

> **Important**
>
> Do not worry too much about failing PR checks! Community members will help you
> to get them fixed, by either providing you with instructions how to fix them
> or by fixing them on your behave.
To learn how to contribute fixes and new content to this project, read the
[Contributor's guide](/content/en/docs/contribute), which includes a style guide
and useful information on the review process.

## Development

Expand Down Expand Up @@ -219,24 +173,6 @@ The website is built from the following content:
[content-modules]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules

### Submitting a change

Before submitting a change to the repository, run the following command and
address any reported issues. Also commit any files changed by the `fix` script:

```sh
npm run test-and-fix
```

To separately test and fix issues with your files, run:

```sh
npm run test # checks but does not update any files
npm run fix # may update files
```

To list available NPM scripts, run `npm run`.

### Submodule changes

If you change any content inside of a [content-modules][] submodule, then you'll
Expand All @@ -255,17 +191,6 @@ submodule itself.
> You'll also need to `git fetch --unshallow` the submodule before you can
> submit a PR. Alternatively, set `DEPTH=100` and re-fetch submodules.

### Site deploys and PR previews

If you submit a PR, Netlify will create a [deploy preview][] so that you can
review your changes. Once your PR is merged, Netlify deploys the updated site to
the production server.

> **Note**: PR previews include _draft pages_, but production builds do not.

To see deploy logs and more, visit project's [dashboard][] -- Netlify login
required.

## Approver and Maintainer practices

This last section includes guidelines and some common practices used by
Expand Down Expand Up @@ -302,18 +227,12 @@ approvers and maintainers while doing code reviews:
[.nvmrc]: .nvmrc
[clone]:
https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
[dashboard]: https://app.netlify.com/sites/opentelemetry/overview
[deploy preview]:
https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/
[editing files]:
https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
[gitpod.io]: https://gitpod.io
[gitpod.io/workspaces]: https://gitpod.io/workspaces
[hugo]: https://gohugo.io
[localhost:1313]: http://localhost:1313
[localhost:8888]: http://localhost:8888
[netlify]: https://netlify.com
[new-issue]:
https://github.com/open-telemetry/opentelemetry.io/issues/new/choose
[nodejs-rel]: https://nodejs.org/en/about/previous-releases
Expand All @@ -323,5 +242,3 @@ approvers and maintainers while doing code reviews:
https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
[nvm-windows]: https://github.com/coreybutler/nvm-windows
[org]: https://github.com/open-telemetry
[pr]:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
Loading
Loading