Skip to content

Commit

Permalink
Change line lengths to 80 characters. Update contributing accordingly
Browse files Browse the repository at this point in the history
  • Loading branch information
acramsay committed Feb 9, 2024
1 parent 2970fa3 commit 0d86a28
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 35 deletions.
3 changes: 0 additions & 3 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
MD007:
# Spaces for indent
indent: 4
MD013:
# Number of characters
line_length: 90
24 changes: 13 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ Your contributions are welcome and encouraged! Thanks for contributing.

## Contribution Scope and Github Issues

Changes that are small in scope may be submitted *without* opening a Github issue. This is
viable when correcting typos or small grammatical errors. It may also be viable when
rewording a sentence or paragraph simply for clarity.
Changes that are small in scope may be submitted *without* opening a Github
issue. This is viable when correcting typos or small grammatical errors. It may
also be viable when rewording a sentence or paragraph simply for clarity. These
PRs may be approved, merged, or declined without discussion.

For any other changes, please open a Github issue to propose your changes where they can
be discussed and planned openly. This is appropriate when meaningfully changing or
introducing new content. The content in question could be ideas, recommendations,
diagrams, architectures, tools, etc.
For any other changes, please open a Github issue to propose your changes where
they can be discussed and planned openly. This is appropriate when meaningfully
changing or introducing new content. The content in question could be ideas,
recommendations, diagrams, architectures, tools, etc.

If you are unsure if an issue is needed, please open an issue to discuss your change.
If you are unsure if an issue is needed, please open an issue to discuss your
change.

## Commits, Branches, and Pull Requests

All contributions should be committed to a branch and reviewed with a pull request. Forks
certainly may be used but are not required. Commits and pull requests should follow
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
All contributions should be committed to a branch and reviewed with a pull
request. Forks certainly may be used but are not required. Commits and pull
requests should follow [ConventionalCommits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
47 changes: 26 additions & 21 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,43 @@
# Contributing to OpenO11y

Anyone is welcome to contribute to OpenO11y and its open projects. There are a few major
aspects of this project to which one can contribute. This guide will help you understand
how our project works and how you can contribute effectively. If you have any questions
that aren't answered in this guide, please reach out by creating a [GitHub issue](https://github.com/liatrio/openo11y.dev/issues).
Anyone is welcome to contribute to OpenO11y and its open projects. There are a
few major aspects of this project to which one can contribute. This guide will
help you understand how our project works and how you can contribute
effectively. If you have any questions that aren't answered in this guide,
please reach out by creating a [GitHub issue](https://github.com/liatrio/openo11y.dev/issues).

We look forward to your contributions!

## Github Repositories

The following repositories relate to or are actively developed as part of **OpenO11y**.
The following repositories relate to or are actively developed as part of
**OpenO11y**.

- [openo11y.dev](https://github.com/liatrio/openo11y.dev) The source for this site
- [aws-managed-service-module](https://github.com/liatrio/aws-managed-services) TF module
for managed services in AWS for o11y
- [liatrio-otel-collector](https://github.com/liatrio/liatrio-otel-collector) Liatrio's
distribution of the OTEL Collector
- [openo11y.dev](https://github.com/liatrio/openo11y.dev) The source for this
site
- [aws-managed-service-module](https://github.com/liatrio/aws-managed-services)
TF module for managed services in AWS for o11y
- [liatrio-otel-collector](https://github.com/liatrio/liatrio-otel-collector)
Liatrio's distribution of the OTEL Collector
- [opentelemetry-collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib)
the repo we fork and contribute to on the OTEL project
- [oteps](https://github.com/open-telemetry/oteps) the repo we fork for enhancement
proposals contributing back to the community via OTEL
- [oteps](https://github.com/open-telemetry/oteps) the repo we fork for
enhancement proposals contributing back to the community via OTEL

Anyone is welcome to contribute to any of these projects. These projects generally expect
that contributions start with a Github issue where proposed changes can be discussed and
planned openly. However, each project is independent and contributors should refer to the
documentation within each project for detailed instructions.
Anyone is welcome to contribute to any of these projects. These projects
generally expect that contributions start with a Github issue where proposed
changes can be discussed and planned openly. However, each project is
independent and contributors should refer to the documentation within each
project for detailed instructions.

## Github Issues

All of our projects generally expect that contributions start with a Github issue where
proposed changes can be discussed and planned openly.
All of our projects generally expect that contributions start with a Github
issue where proposed changes can be discussed and planned openly.

## Open Source Projects

We rely heavily on open source projects. If you find a bug or feature that you think
should be implemented in one of these projects, consider contributing there first. This
includes submitting PRs to forked projects that are hosted internally.
We rely heavily on open source projects. If you find a bug or feature that you
think should be implemented in one of these projects, consider contributing
there first. This includes submitting PRs to forked projects that are hosted
internally.

0 comments on commit 0d86a28

Please sign in to comment.