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.

Sign up for GitHub

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

docs(CONTRIBUTING.md) update wording and fix mistake #448

Merged
merged 2 commits into from
Oct 19, 2022
Merged

docs(CONTRIBUTING.md) update wording and fix mistake #448

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b5401a
Update CONTRIBUTING.md
ArjunSharda Oct 17, 2022
140d6a2
Update CONTRIBUTING.md
ArjunSharda Oct 17, 2022
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
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ The easiest way to get started with developing Encore is using
GitHub Codespaces. Simply open this repository in a new Codespace
and your development environment will be set up with everything preconfigured for building the `encore` CLI and running applications with it.

This also works just as well with [VS Code's Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).
This also works just as well with [Visual Studio Code's Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).


## Building the encore command from source
To build from source, [build the dashboard](#Building-the-Development-Dashboard) and simply run `go build ./cli/cmd/encore`.

Running an Encore application requires both the Encore runtime (the `encore.dev` package) as well as a custom-built
([Go runtime](https://github.com/encoredev/go)) to implement Encore's request semantics and automated instrumentation.
[Go runtime](https://github.com/encoredev/go) to implement Encore's request semantics and automated instrumentation.

As a result the Encore Daemon must know where these two things exist on the filesystem in order to properly compile the Encore application.

Expand All @@ -32,7 +32,7 @@ The environment variables are:
**ENCORE_RUNTIME_PATH**

This must be set to the location of the `encore.dev` runtime package.
It's located in this Git repository in the `runtime` directory:
It's located in encore's GitHub repository in the `runtime` directory:

```bash
export ENCORE_RUNTIME_PATH=/path/to/encore/runtime
Expand Down Expand Up @@ -85,7 +85,7 @@ npm run build
```

### Testing the Development Dashboard
Tests are written using [Jest](https://jestjs.io/) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/).
Tests are written using [Jest](https://jestjs.io/) and the [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/).

To run the front-end unit tests:

Expand All @@ -97,7 +97,7 @@ npm test -- --watch #re-run tests on file change

## Architecture

The code base is divided into several parts:
encore's code base is divided into several parts:

### cli
The `encore` command line interface. The encore background daemon
Expand Down