Skip to content

Commit

Permalink
docs: typo and phrasing in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
edustri2 authored May 15, 2024
1 parent e71c27b commit 079c661
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Contributing to Numerous SDK

Here are the guidelines for contributing to Numerous SDK! They are chosen with
the goal of creating a good environment for developing Numerous SDK to a high
the aim of creating a good environment for developing Numerous SDK to a high
level of quality and consistency.

## Linting, pre-commit and testing

We recommend setting up the pre-commit hooks defined in the repositoriy, in
to make sure that linters and tests all pass, before committing and pushing.
We recommend setting up the pre-commit hooks defined in the repository
to ensure that all linters and tests are passing before a commit or push.

Reviews in general require tests and linters to pass.

Expand All @@ -19,19 +19,19 @@ the [actual style guide itself](https://google.github.io/styleguide/go/style),
and the set of
[best practices](https://google.github.io/styleguide/go/best-practices).

These documents may be referenced in reviews for code style suggestions.
These documents can be referenced in reviews for code style suggestions.

Above all, we encourage developers to prioritize designing their code so that it
is readable and understandable for other developers (or themselves, in the
is readable and understandable by other developers (or themselves, in the
future!), easy to modify, and testable.

We also expect new features added to have an assoiciated test suite, which
We also expect new features added to have an associated test suite, which
should be usable as documentation to understand the expectations of the new
code.

## Git workflow

When you create a pull request with changes, please consider the following
When creating a pull request with changes, please consider the following
points:

* We use
Expand Down

0 comments on commit 079c661

Please sign in to comment.