Skip to content

Commit 7652c55

Browse files
committed
Do the fixes which stick pointed out
1 parent 53b0f1d commit 7652c55

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/useful/quickstart.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Now, to make the file in the first place before making a pull request, you have
2020

2121
After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there.
2222

23-
You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json`. (Replace `subdomain` with the name you want to register of course)
23+
You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json` (Replace `subdomain` with the name you want to register of course). For more information about what filenames are valid or invalid, click [here](https://docs.is-a.dev/domain-structure/#-filename-guidelines).
2424

2525
After you've finished with the filename, you can start making the file format of the JSON file. Now depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support.
2626

@@ -45,7 +45,14 @@ When you've made sure that you have the valid file format and the correct filena
4545

4646
Assuming you know how GitHub works, it should be easy for you to make a pull request to our repository. For those who don't know how to make one, you can check [this guide from GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on how to do it.
4747

48-
Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time. When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made.
48+
Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time.
49+
50+
!!!danger
51+
Please don't replace the pull request template with something else, since that could result in your pull request being closed instantly when a maintainer sees it. Please also add a preview of your website with both the link to your website and a screenshot of your website in the pull request description.
52+
!!!
53+
54+
When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made.
55+
4956

5057
# What do I do now?
5158

0 commit comments

Comments
 (0)