Skip to content

Add getting started for contributing to README.md #393

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

Closed
wants to merge 1 commit into from
Closed

Add getting started for contributing to README.md #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ dist
out
.DS_Store
release
*.pem
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,25 @@ How to [secure your setup](/doc/security/ssl.md).

## Contributing

Development guides are coming soon.
### Getting started
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have a Getting Started guide, so this could be confusing. Where do you think this should be placed @nol166 ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this might be good as its own file in the doc/security directory or right in the SSL.md file for other ways to secure your setup. Maybe add a note that brew is only available for Mac.


With localhost ssl (optional):

```
brew install mkcert
mkcert -install
mkcert localhost ::1 127.0.0.1
```

Running code-server:
```
yarn install
yarn task vscode:install
# without ssl
yarn start --password=password --allow-http
# with ssl
yarn start --cert=$(pwd)/localhost+2.pem --cert-key=$(pwd)/localhost+2-key.pem --password=password
```

## License

Expand Down