Merge pull request #33 from github/aeisenberg/private-fork-readme

Add instructions on how to make a private fork
This commit is contained in:
Robert Marsh 2020-07-01 13:44:12 -07:00 коммит произвёл GitHub
Родитель 84308761b5 064b1d43fb
Коммит 86a2f26779
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 11 добавлений и 0 удалений

Просмотреть файл

@ -16,6 +16,17 @@ A starter workspace to use with the [CodeQL extension for Visual Studio Code](ht
- The folders named `codeql-custom-queries-<language>` are ready for you to start developing your own custom queries for each language, while using the standard libraries. There are some example queries to get you started.
1. Follow the [documentation for the CodeQL extension](https://help.semmle.com/codeql/codeql-for-vscode.html) to learn how to set up the extension, add a database and run queries against it. Have fun!
## Using the `vscode-codeql-starter` in a private repository
If you want to privately share your Code QL queries with your teammates using this project as a template:
1. Create an empty, private project in the organization you want.
1. Clone this project locally: `git clone git@github.com:github/vscode-codeql-starter.git`
1. Add a remote to the local copy `git remote add my-org git@github.com:<MY-ORG>/vscode-codeql-starter.git`
1. Push the code to the new remote: `git push my-org master`
GitHub does not allow private forks of public repositories.
## Contributing
This project welcomes contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.