Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@
6. Packages should use package name (e.g. `@sourcegraph/wildcard`) for imports instead of the relative paths (e.g. `../../../../wildcard/src/components/Markdown`) to avoid long relative-paths and make dependency graph between packages clear. (Typescript will warn if packages have circular dependencies). It's easy to refactor such isolated packages, extract functionality into new ones, or even into new repositories.

7. **build** or **config** package should be added later to encapsulate all the configurations reused between packages which will allow removing `jest.config`, `babel.config` from the root of the repo.
Hello Hello!
1 change: 1 addition & 0 deletions client/branded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ This folder contains client code that is **branded**, i.e. it implements the vis
Code in here can use Bootstrap and must not adapt styles of the code host (for more details, see [Styling UI in the handbook](https://about.sourcegraph.com/handbook/engineering/web/styling)).

Any code that is code host agnostic should go into [`../shared`](../shared) instead.
Hello Hello!
1 change: 1 addition & 0 deletions client/browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,4 @@ Use this process to create a source code zip to attach to a Firefox add-on submi
cd client/browser
yarn run create-source-zip
```
Hello Hello!
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Browser APIs

This directory contains a set of helper functions that wrap the [APIs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API) exposed by the browser to browser extensions. This originally came about while implementing support for Safari. Rather than write an entirely new extension, we wrapped the APIs and implemented pseudo support for these APIs in Safari. At this time, we no longer support Safari, however we have kept these because there are still differences in the APIs between Chrome and Firefox. This abstraction also allowed us to have a more type safe interaction with the APIs in actual application code.
Hello Hello!
1 change: 1 addition & 0 deletions client/eslint-plugin-sourcegraph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ Unit tests can be run with:
```sh
yarn test
```
Hello Hello!
1 change: 1 addition & 0 deletions client/extension-api-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ Extensions should use the `sourcegraph` package, not this package. This package
that embed Sourcegraph extensions and need to communicate with them.

See [Sourcegraph extensions documentation](https://docs.sourcegraph.com/extensions) for more information.
Hello Hello!
1 change: 1 addition & 0 deletions client/extension-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
This package contains only the types for the [Sourcegraph extension API](https://unpkg.com/sourcegraph/dist/docs/index.html) ([`sourcegraph.d.ts`](https://github.com/sourcegraph/sourcegraph/blob/main/packages/extension-api/src/sourcegraph.d.ts)).

See [Sourcegraph extensions documentation](https://docs.sourcegraph.com/extensions) for more information.
Hello Hello!
1 change: 1 addition & 0 deletions client/shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ In particular, components cannot make use of Bootstrap classes, but must accept
For more details, see [Styling UI in the handbook](https://about.sourcegraph.com/handbook/engineering/web/styling).

Code that is only used in branded contexts (web app, options menu of the browser extension, ...) should go into [`../branded`](../branded) instead.
Hello Hello!
1 change: 1 addition & 0 deletions client/shared/src/testing/integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
This folder contains shared testing helpers for the Sourcegraph webapp and browser extensions.

For more information about integration tests and how to run them, read the [Client integration tests documentation](https://docs.sourcegraph.com/dev/testing#client-integration-tests).
Hello Hello!
1 change: 1 addition & 0 deletions client/storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ The [DLL Plugin](https://webpack.js.org/plugins/dll-plugin/) is used to move mos
7. Storybook development server starts 🎉.

If DLL bundle and Webpack stats are in place, all intermediate steps are skipped straight to the start of Storybook development server.
Hello Hello!
1 change: 1 addition & 0 deletions client/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ Build artifacts will be served from `<rootRepoPath>/ui/assets`.
In both environments, server proxies API requests to `SOURCEGRAPH_API_URL` provided as the `.env` variable.
To avoid the `CSRF token is invalid` error CSRF token is retrieved from the `SOURCEGRAPH_API_URL` before the server starts.
Then this value is used for every subsequent request to the API.
Hello Hello!
1 change: 1 addition & 0 deletions client/web/src/components/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Components that are shared through the app
Hello Hello!
1 change: 1 addition & 0 deletions client/web/src/regression/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,4 @@ Test best practices:
test users easy to clean up manually if necessary.
- **Ask for help**: Regression tests are intended to be relatively easy and straightforward to write. If you find
yourself spending a lot of time implementing simple behavior, file an issue and tag @beyang.
Hello Hello!
1 change: 1 addition & 0 deletions client/web/src/search/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Components for search UI in the app.
Hello Hello!
1 change: 1 addition & 0 deletions client/web/src/search/results/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Components for the search results page
Hello Hello!
1 change: 1 addition & 0 deletions client/wildcard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ The Wildcard component library is a collection of design-approved reusable compo
Reusable React hooks. Typically utilities or headless components

See [Wildcard documentation](https://docs.sourcegraph.com/dev/background-information/web/wildcard) for more information.
Hello Hello!