mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-21 20:45:33 +03:00
Pull request 2181: imp-docs
Squashed commit of the following:
commit 1f7be03896a6eaf0a292e4c7e9a7ef7c712ed734
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Thu Mar 21 13:35:37 2024 +0300
all: use standard md style in some docs
This commit is contained in:
Ainar Garipov
parent
2e5595defd
commit
70c88f2ba2
3 changed files with 53 additions and 99 deletions
|
|
@ -1,89 +1,57 @@
|
||||||
# Contributing to AdGuard Home
|
# Contributing to AdGuard Home
|
||||||
|
|
||||||
If you want to contribute to AdGuard Home by filing or commenting on an issue or
|
If you want to contribute to AdGuard Home by filing or commenting on an issue or opening a pull request, please follow the instructions below.
|
||||||
opening a pull request, please follow the instructions below.
|
|
||||||
|
|
||||||
|
## General recommendations
|
||||||
|
|
||||||
|
Please don’t:
|
||||||
|
|
||||||
## General recommendations
|
- post comments like “+1” or “this”. Use the :+1: reaction on the issue instead, as this allows us to actually see the level of support for issues.
|
||||||
|
|
||||||
Please don't:
|
- file issues about localization errors or send localization updates as PRs. We’re using [CrowdIn] to manage our translations and we generally update them before each Beta and Release build. You can learn more about translating AdGuard products [in our Knowledge Base][kb-trans].
|
||||||
|
|
||||||
* post comments like “+1” or “this”. Use the :+1: reaction on the issue
|
- file issues about a particular filtering-rule list misbehaving. These are tracked through the [separate form for filtering issues][form].
|
||||||
instead, as this allows us to actually see the level of support for issues.
|
|
||||||
|
|
||||||
* file issues about localization errors or send localization updates as PRs.
|
- send or request updates to filtering-rule lists, such as the ones for the Blocked Services feature or the list of approved filtering-rule lists. We update them from the [separate repository][hostlist] once before each Beta and Release build.
|
||||||
We're using [CrowdIn] to manage our translations and we generally update
|
|
||||||
them before each Beta and Release build. You can learn more about
|
|
||||||
translating AdGuard products [in our Knowledge Base][kb-trans].
|
|
||||||
|
|
||||||
* file issues about a particular filtering-rule list misbehaving. These are
|
|
||||||
tracked through the [separate form for filtering issues][form].
|
|
||||||
|
|
||||||
* send updates to filtering-rule lists, such as the ones for the Blocked
|
|
||||||
Services feature or the list of approved filtering-rule lists. We update
|
|
||||||
them once before each Beta and Release build.
|
|
||||||
|
|
||||||
Please do:
|
Please do:
|
||||||
|
|
||||||
* follow the template instructions and provide data for reproducing issues.
|
- follow the template instructions and provide data for reproducing issues.
|
||||||
|
|
||||||
* write the title of your issue or pull request in English. Any language is
|
- write the title of your issue or pull request in English. Any language is fine in the body, but it is important to keep the title in English to make it easier for people and bots to look up duplicated issues.
|
||||||
fine in the body, but it is important to keep the title in English to make
|
|
||||||
it easier for people and bots to look up duplicated issues.
|
|
||||||
|
|
||||||
[CrowdIn]: https://crowdin.com/project/adguard-applications/en#/adguard-home
|
[CrowdIn]: https://crowdin.com/project/adguard-applications/en#/adguard-home
|
||||||
[form]: https://link.adtidy.org/forward.html?action=report&app=home&from=github
|
[form]: https://link.adtidy.org/forward.html?action=report&app=home&from=github
|
||||||
|
[hostlist]: https://github.com/AdguardTeam/HostlistsRegistry
|
||||||
[kb-trans]: https://kb.adguard.com/en/general/adguard-translations
|
[kb-trans]: https://kb.adguard.com/en/general/adguard-translations
|
||||||
|
|
||||||
|
## Issues
|
||||||
|
|
||||||
|
### Search first
|
||||||
|
|
||||||
## Issues
|
Please make sure that the issue is not a duplicate or a question. If it’s a duplicate, please react to the original issue with a thumbs up. If it’s a question, please look through our [Wiki] and, if you haven’t found the answer, post it to the GitHub [Discussions] page.
|
||||||
|
|
||||||
### Search first
|
|
||||||
|
|
||||||
Please make sure that the issue is not a duplicate or a question. If it's a
|
|
||||||
duplicate, please react to the original issue with a thumbs up. If it's a
|
|
||||||
question, please look through our [Wiki] and, if you haven't found the answer,
|
|
||||||
post it to the GitHub [Discussions] page.
|
|
||||||
|
|
||||||
[Discussions]: https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a
|
[Discussions]: https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a
|
||||||
[Wiki]: https://github.com/AdguardTeam/AdGuardHome/wiki
|
[Wiki]: https://github.com/AdguardTeam/AdGuardHome/wiki
|
||||||
|
|
||||||
|
### Follow the issue template
|
||||||
|
|
||||||
|
Developers need to be able to reproduce the faulty behavior in order to fix an issue, so please make sure that you follow the instructions in the issue template carefully.
|
||||||
|
|
||||||
### Follow the issue template
|
## Pull requests
|
||||||
|
|
||||||
Developers need to be able to reproduce the faulty behavior in order to fix an
|
### Discuss your changes first
|
||||||
issue, so please make sure that you follow the instructions in the issue
|
|
||||||
template carefully.
|
|
||||||
|
|
||||||
|
Please discuss your changes by opening an issue. The maintainers should evaluate your proposal, and it’s generally better if that’s done before any code is written.
|
||||||
|
|
||||||
|
### Review your changes for style
|
||||||
|
|
||||||
## Pull requests
|
We have a set of [code guidelines][hacking] that we expect the code to follow. Please make sure you follow it.
|
||||||
|
|
||||||
### Discuss your changes first
|
|
||||||
|
|
||||||
Please discuss your changes by opening an issue. The maintainers should
|
|
||||||
evaluate your proposal, and it's generally better if that's done before any code
|
|
||||||
is written.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Review your changes for style
|
|
||||||
|
|
||||||
We have a set of [code guidelines][hacking] that we expect the code to follow.
|
|
||||||
Please make sure you follow it.
|
|
||||||
|
|
||||||
[hacking]: https://github.com/AdguardTeam/CodeGuidelines/blob/master/Go/Go.md
|
[hacking]: https://github.com/AdguardTeam/CodeGuidelines/blob/master/Go/Go.md
|
||||||
|
|
||||||
|
### Test your changes
|
||||||
|
|
||||||
|
Make sure that it passes linters and tests by running the corresponding Make targets. For backend changes, it’s `make go-check`. For frontend, run `make js-lint`.
|
||||||
|
|
||||||
### Test your changes
|
Additionally, a manual test is often required. While we’re constantly working on improving our test suites, they’re still not as good as we’d like them to be.
|
||||||
|
|
||||||
Make sure that it passes linters and tests by running the corresponding Make
|
|
||||||
targets. For backend changes, it's `make go-check`. For frontend, run
|
|
||||||
`make js-lint`.
|
|
||||||
|
|
||||||
Additionally, a manual test is often required. While we're constantly working
|
|
||||||
on improving our test suites, they're still not as good as we'd like them to be.
|
|
||||||
|
|
|
||||||
53
HACKING.md
53
HACKING.md
|
|
@ -1,65 +1,56 @@
|
||||||
# AdGuard Home Developer Guidelines
|
# AdGuard Home developer guidelines
|
||||||
|
|
||||||
This document was moved to the [AdGuard Code Guidelines repository][repo]. All
|
This document was moved to the [AdGuard Code Guidelines repository][repo]. All sections with IDs now only have links to the corresponding files and sections in that repository.
|
||||||
sections with IDs now only have links to the corresponding files and sections in
|
|
||||||
that repository.
|
|
||||||
|
|
||||||
## <a href="#git" id="git" name="git">Git</a>
|
## <a href="#git" id="git" name="git">Git</a>
|
||||||
|
|
||||||
This section was moved to [its own document][git].
|
This section was moved to [its own document][git].
|
||||||
|
|
||||||
## <a href="#go" id="go" name="go">Go</a>
|
## <a href="#go" id="go" name="go">Go</a>
|
||||||
|
|
||||||
This section was moved to [its own document][go].
|
This section was moved to [its own document][go].
|
||||||
|
|
||||||
### <a href="#code" id="code" name="code">Code</a>
|
### <a href="#code" id="code" name="code">Code</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][code] of the Go
|
This subsection was moved to the [corresponding section][code] of the Go guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
### <a href="#commenting" id="commenting" name="commenting">Commenting</a>
|
### <a href="#commenting" id="commenting" name="commenting">Commenting</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][cmnt] of the Go
|
This subsection was moved to the [corresponding section][cmnt] of the Go guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
### <a href="#formatting" id="formatting" name="formatting">Formatting</a>
|
### <a href="#formatting" id="formatting" name="formatting">Formatting</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][fmt] of the Go
|
This subsection was moved to the [corresponding section][fmt] of the Go guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
### <a href="#naming" id="naming" name="naming">Naming</a>
|
### <a href="#naming" id="naming" name="naming">Naming</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][name] of the Go
|
This subsection was moved to the [corresponding section][name] of the Go guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
### <a href="#testing" id="testing" name="testing">Testing</a>
|
### <a href="#testing" id="testing" name="testing">Testing</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][test] of the Go
|
This subsection was moved to the [corresponding section][test] of the Go guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
### <a href="#recommended-reading" id="recommended-reading" name="recommended-reading">Recommended Reading</a>
|
### <a href="#recommended-reading" id="recommended-reading" name="recommended-reading">Recommended Reading</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][read] of the Go
|
This subsection was moved to the [corresponding section][read] of the Go guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
## <a href="#markdown" id="markdown" name="markdown">Markdown</a>
|
## <a href="#markdown" id="markdown" name="markdown">Markdown</a>
|
||||||
|
|
||||||
This section was moved to [its own document][md].
|
This section was moved to [its own document][md].
|
||||||
|
|
||||||
## <a href="#shell-scripting" id="shell-scripting" name="shell-scripting">Shell Scripting</a>
|
## <a href="#shell-scripting" id="shell-scripting" name="shell-scripting">Shell Scripting</a>
|
||||||
|
|
||||||
This section was moved to [its own document][sh].
|
This section was moved to [its own document][sh].
|
||||||
|
|
||||||
### <a href="#shell-conditionals" id="shell-conditionals" name="shell-conditionals">Shell Conditionals</a>
|
### <a href="#shell-conditionals" id="shell-conditionals" name="shell-conditionals">Shell Conditionals</a>
|
||||||
|
|
||||||
This subsection was moved to the [corresponding section][cond] of the Shell
|
This subsection was moved to the [corresponding section][cond] of the Shell guidelines document.
|
||||||
guidelines document.
|
|
||||||
|
|
||||||
## <a href="#text-including-comments" id="text-including-comments" name="text-including-comments">Text, Including Comments</a>
|
## <a href="#text-including-comments" id="text-including-comments" name="text-including-comments">Text, Including Comments</a>
|
||||||
|
|
||||||
This section was moved to [its own document][txt].
|
This section was moved to [its own document][txt].
|
||||||
|
|
||||||
## <a href="#yaml" id="yaml" name="yaml">YAML</a>
|
## <a href="#yaml" id="yaml" name="yaml">YAML</a>
|
||||||
|
|
||||||
This section was moved to [its own document][yaml].
|
This section was moved to [its own document][yaml].
|
||||||
|
|
||||||
|
|
|
||||||
19
SECURITY.md
19
SECURITY.md
|
|
@ -1,18 +1,13 @@
|
||||||
# Security Policy
|
# Security Policy
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting vulnerabilities
|
||||||
|
|
||||||
Please send your vulnerability reports to <security@adguard.com>. To make sure
|
Please send your vulnerability reports to <security@adguard.com>. To make sure that your report reaches us, please:
|
||||||
that your report reaches us, please:
|
|
||||||
|
|
||||||
1. Include the words “AdGuard Home” and “vulnerability” to the subject line as
|
1. Include the words “AdGuard Home” and “vulnerability” to the subject line as well as a short description of the vulnerability. For example:
|
||||||
well as a short description of the vulnerability. For example:
|
|
||||||
|
|
||||||
> AdGuard Home API vulnerability: possible XSS attack
|
> AdGuard Home API vulnerability: possible XSS attack
|
||||||
|
|
||||||
2. Make sure that the message body contains a clear description of the
|
2. Make sure that the message body contains a clear description of the vulnerability.
|
||||||
vulnerability.
|
|
||||||
|
|
||||||
If you have not received a reply to your email within 7 days, please make sure
|
If you have not received a reply to your email within 7 days, please make sure to follow up with us again at <security@adguard.com>. Once again, make sure that the word “vulnerability” is in the subject line.
|
||||||
to follow up with us again at <security@adguard.com>. Once again, make sure
|
|
||||||
that the word “vulnerability” is in the subject line.
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue