Skip to content

Commit

Permalink
CONTRIBUTING: ref org-wide guidelines + minor fixes (#443)
Browse files Browse the repository at this point in the history
Reference issue: ooni/probe#1670
  • Loading branch information
bassosimone authored Aug 19, 2021
1 parent 1874f7a commit 4a9e76e
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ to open pull requests. An open pull request will be reviewed by a core
developer. The review may request you to apply changes. Once the assigned
reviewer is satisfied, they will merge the pull request.

## Opening issues
## OONI Software Development Guidelines

Please, before opening a new issue, check whether the issue or feature request
you want us to consider has not already been reported by someone else.
Please, make sure you read [OONI Software Development Guidelines](
https://ooni.org/post/ooni-software-development-guidelines/). We try in
general to follow these guidelines when working on ooni/probe-cli. In
the unlikely care where those guidelines conflict with this document, this
document will take precedence.

For new issues, please use: [github.com/ooni/probe](
https://github.com/ooni/probe/issues/new?labels=ooni/probe-cli&assignee=bassosimone).
## Opening issues

Please, also check [github.com/ooni/probe-engine](
https://github.com/ooni/probe-engine) for legacy issues. This is
the repository where the measurement engine previously was located.
Please, before opening a new issue, check whether the issue or feature request
you want us to consider has not already been reported by someone else. The
issue tracker is at [github.com/ooni/probe/issues](https://github.com/ooni/probe/issues).

## PR requirements

Expand All @@ -26,7 +28,7 @@ request that modifies existing functionality should not decrease the
existing code coverage.

Long-running tests should be skipped when running tests in short mode
using `go test -short`. We prefer external testing to internal
using `go test -short`. We prefer internal testing to external
testing. We generally have a file called `foo_test.go` with tests
for every `foo.go` file. Sometimes we separate long running
integration tests in a `foo_integration_test.go` file.
Expand Down Expand Up @@ -89,4 +91,6 @@ To get a sense of what we expect from an experiment, see:

- the internal/engine/experiment/webconnectivity experiment

- the [internal/tutorial](https://github.com/ooni/probe-cli/tree/master/internal/tutorial) tutorial

Thank you!

0 comments on commit 4a9e76e

Please sign in to comment.