StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-02-24 15:43:08 +08:00
Code Issues Projects Releases Packages Wiki Activity

Docs: Fixed step number in writing-providers (#2820)

Browse source 
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
陸 2024-01-29 20:35:12 +09:00 committed by GitHub
parent d1b599b795
commit e3ea652af3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
documentation/writing-providers.md
View file

@ -232,7 +232,7 @@ an automated way to test for this bug. The manual steps are here in
a particular integration test, or request feedback. a particular integration test, or request feedback.
{% endhint %} {% endhint %}
## Step 9: Capabilities ## Step 10: Capabilities
Some DNS providers have features that others do not. For example some Some DNS providers have features that others do not. For example some
support the SRV record. A provider announces what it can do using support the SRV record. A provider announces what it can do using
@ -265,7 +265,7 @@ you want to implement.
FYI: If a provider's capabilities changes, run `go generate` to update FYI: If a provider's capabilities changes, run `go generate` to update
the documentation. the documentation.
## Step 10: Automated code tests ## Step 11: Automated code tests
Run `go vet` and [`staticcheck`](https://staticcheck.io/) and clean up any errors found. Run `go vet` and [`staticcheck`](https://staticcheck.io/) and clean up any errors found.
@ -289,17 +289,17 @@ go install golang.org/x/lint/golint
golint ./... golint ./...
``` ```
## Step 11: Dependencies ## Step 12: Dependencies
See [documentation/release-engineering.md](release-engineering.md) See [documentation/release-engineering.md](release-engineering.md)
for tips about managing modules and checking for outdated for tips about managing modules and checking for outdated
dependencies. dependencies.
## Step 12: Modify the release regexp ## Step 13: Modify the release regexp
In the repo root, open `.goreleaser.yml` and add the provider to `Provider-specific changes` regexp. In the repo root, open `.goreleaser.yml` and add the provider to `Provider-specific changes` regexp.
## Step 13: Check your work ## Step 14: Check your work
These are the things we'll be checking when you submit the PR. Please try to complete all or as many of these as possible. These are the things we'll be checking when you submit the PR. Please try to complete all or as many of these as possible.
@ -315,12 +315,12 @@ These are the things we'll be checking when you submit the PR. Please try to co
* `integrationTest/providers.json` * `integrationTest/providers.json`
* `providers/_all/all.go` * `providers/_all/all.go`
3. Review the code for style issues, remove debug statements, make sure all exported functions have a comment, and generally tighten up the code. 3. Review the code for style issues, remove debug statements, make sure all exported functions have a comment, and generally tighten up the code.
4. Verify you're using the most recent version of anything you import. (See [Step 13](#step-11-dependencies)) 4. Verify you're using the most recent version of anything you import. (See [Step 12](#step-12-dependencies))
5. Re-run the [integration test](#step-7-integration-test) one last time. 5. Re-run the [integration test](#step-7-integration-test) one last time.
* Post the results as a comment to your PR. * Post the results as a comment to your PR.
6. Re-read the [maintainer's responsibilities](providers.md#providers-with-contributor-support) bullet list. By submitting a provider you agree to maintain it, respond to bugs, periodically re-run the integration test to verify nothing has broken, and if we don't hear from you for 2 months we may disable the provider. 6. Re-read the [maintainer's responsibilities](providers.md#providers-with-contributor-support) bullet list. By submitting a provider you agree to maintain it, respond to bugs, periodically re-run the integration test to verify nothing has broken, and if we don't hear from you for 2 months we may disable the provider.
## Step 14: Submit a PR ## Step 15: Submit a PR
At this point you can submit a PR. At this point you can submit a PR.
@ -328,7 +328,7 @@ Actually you can submit the PR even earlier if you just want feedback,
input, or have questions. This is just a good stopping place to input, or have questions. This is just a good stopping place to
submit a PR if you haven't already. submit a PR if you haven't already.
## Step 15: After the PR is merged ## Step 16: After the PR is merged
1. Close any related GitHub issues. 1. Close any related GitHub issues.
3. Would you like your provider to be tested automatically as part of every PR? Sure you would! Follow the instructions in [Bring-Your-Own-Secrets for automated testing](byo-secrets.md) 3. Would you like your provider to be tested automatically as part of every PR? Sure you would! Follow the instructions in [Bring-Your-Own-Secrets for automated testing](byo-secrets.md)