Skip to content

Commit db2ece4

Browse files
Merge pull request circleci#6722 from circleci/note-empty-repo-odk
docs: warn new orb repos must be empty
2 parents 8e37533 + 687be54 commit db2ece4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

jekyll/_cci2/orb-author.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,13 @@ To begin creating your new orb with the Orb Development Kit, follow the steps be
4040

4141
Ensure the organization on GitHub is the owner for the [CircleCI namespace]({{site.baseurl}}/2.0/orb-concepts/#namespaces) for which you are developing your orb. If this is your own personal organization and namespace, you need not worry.
4242

43-
1. **Create a new [GitHub repository](https://github.com/new).**
43+
1. **Create a new _empty_ [GitHub repository](https://github.com/new).**
4444

4545
The name of your repository is not critical, but we recommend something similar to "myProject-orb". ![New GitHub Repo]({{site.baseurl}}/assets/img/docs/new_orb_repo_gh.png)
4646

47+
**Note:** Ensure that the repository is completely empty. Uncheck any options such as "Add a README.md" or "Choose a license".
48+
{: class="alert alert-warning"}
49+
4750
When complete, you will be brought to a page confirming your new repository and you should see the generated git URL. Note down the git URL, you will need it in step 4. You can select SSH or HTTPS, whichever you can authenticate with. ![Orb Registry]({{site.baseurl}}/assets/img/docs/github_new_quick_setup.png)
4851

4952
**Note:** While you must create a local directory for your orb before initializing, it is not necessary to pull down the orb repository. This process will be completed in the `orb init` process and pulling the repository beforehand will cause issues.

0 commit comments

Comments
 (0)