Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 7957f2e

Browse files
Add contributing docs
1 parent e8aba0b commit 7957f2e

File tree

2 files changed

+46
-35
lines changed

2 files changed

+46
-35
lines changed

‎CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing
2+
3+
## Development
4+
5+
```console
6+
mkdir extensions
7+
go run ./cmd/marketplace/main.go server [flags]
8+
```
9+
10+
When you make a change that affects people deploying the marketplace please
11+
update the changelog as part of your PR.
12+
13+
You can use `make gen` to generate a mock `extensions` directory for testing and
14+
`make upload` to upload them to an Artifactory repository.
15+
16+
## Tests
17+
18+
To run the tests:
19+
20+
```
21+
make test
22+
```
23+
24+
To run the Artifactory tests against a real repository instead of a mock:
25+
26+
```
27+
export ARTIFACTORY_URI=myuri
28+
export ARTIFACTORY_REPO=myrepo
29+
export ARTIFACTORY_TOKEN=mytoken
30+
make test
31+
```
32+
33+
See the readme for using the marketplace with code-server.
34+
35+
When testing with code-server you may run into issues with content security
36+
policy if the marketplace runs on a different domain over HTTP; in this case you
37+
will need to disable content security policy in your browser or manually edit
38+
the policy in code-server's source.
39+
40+
## Releasing
41+
42+
1. Check that the changelog lists all the important changes.
43+
2. Update the changelog with the release date.
44+
3. Push a tag with the new version.
45+
4. Update the resulting draft release with the changelog contents.
46+
5. Publish the draft release.

‎README.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -167,41 +167,6 @@ Although not officially supported, you can follow the examples below to start us
167167
- [VS Code](https://github.com/eclipse/openvsx/wiki/Using-Open-VSX-in-VS-Code)
168168
- [VSCodium](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#how-to-use-the-vs-code-marketplace)
169169

170-
## Development
171-
172-
```console
173-
mkdir extensions
174-
go run ./cmd/marketplace/main.go server [flags]
175-
```
176-
177-
When testing with code-server you may run into issues with content security
178-
policy if the marketplace runs on a different domain over HTTP; in this case you
179-
will need to disable content security policy in your browser or manually edit
180-
the policy in code-server's source.
181-
182-
When you make a change that affects people deploying the marketplace please
183-
update the changelog as part of your PR.
184-
185-
You can use `make gen` to generate a mock `extensions` directory for testing and
186-
`make upload` to upload them to an Artifactory repository.
187-
188-
### Tests
189-
190-
To run the tests:
191-
192-
```
193-
make test
194-
```
195-
196-
To run the Artifactory tests against a real repository instead of a mock:
197-
198-
```
199-
export ARTIFACTORY_URI=myuri
200-
export ARTIFACTORY_REPO=myrepo
201-
export ARTIFACTORY_TOKEN=mytoken
202-
make test
203-
```
204-
205170
## Missing features
206171

207172
- Recommended extensions.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /