-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
110 additions
and
110 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,29 @@ | ||
# Contributing to orbit | ||
|
||
### Finding a task | ||
## Finding a task | ||
|
||
Before contributing to this project, please ensure that an open issue first exists outlining that issue you plan to resolve. | ||
|
||
### Running the project | ||
## Running the project | ||
|
||
To run the project, please first download the required tools. | ||
|
||
- nodeJS >= v11 | ||
- golang 1.14 | ||
|
||
### Building the project | ||
## Building the project | ||
|
||
After golang is installed on your machine, you can build with `go run build` | ||
|
||
### Running tests | ||
You can run the tests with `make test` | ||
## Running tests | ||
|
||
### Requirements | ||
|
||
- lighthouse CLI `npm i -g lighthouse` | ||
- pytest `pip install pytest` | ||
|
||
You can run the entire test suite with `make test` or the go tests with `make gotest` or integration tests with `make integrationtest` | ||
|
||
## Committing code | ||
|
||
### Committing code | ||
This project uses the golang project standard for commit messages, you find it [here](https://go.dev/doc/contribute#commit_messages). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters