Page MenuHomeMy privacy DNS

Contributing
Updated 208 Days AgoPublic

If you feel like contributing there are a couple of ways to do this

  1. You can add new super high speed bash code, optimizing existing, rewrite for broader support of bash environments across OS's
  2. You can add domains to either the wildcard.list or domain.list in there respective folders
  3. You can through Damned good arguments try to get a domain into the WhiteList
  4. Simply open a new Ticket with your suggestion if there not already is one for the primary domain.
    1. Please read our Ticket Guide before submitting a new domain
    2. If there is a existing issue for the TLD you have a submission to, then add you submission as comment to that one. An example to this could be T70: google.com
    3. If there isn't any existing issue related to the domain you would like to contribute with, then please do open a new issue.

Workflow

The workflow is a bit clumsy, but yet the most reliable and simple.

  1. You add an issue describing your submission. Pick the issue template that fits your mission best.
  2. You should always be as close as possible to our Writing Guide as possible.
  3. Edit the file you would like to contribute to.
  4. Then open a Pull Request (PR) where you'll add you contribution
  5. Add full URI of the Issue and the domain_name in the commit message, as per the example below.
git commit -S -am "example.com" -m "Closes T3329    https://www.mypdns.org/T3329"

Why first issue then MR/PR?

The simplest idea is often the most safe, and this is the very reason for this workflow. It is also giving the project a searchable database for added domains and it's comments, by which we can't add in other logically ways.

GPG signed

We require all submissions to be signed with a valid GPG key.

Only exception for this rule is the CI/CD bot

How to sign with GPG

If you know nothing about GPG keys, we recommend you to search on duckduckgo.com for the best way, to do it, for the OS you are using.

However if you do have a GPG key, add it to you submission profile and add a -S to git commit -S -m "Some very cool enhancements" and that's is.
You can set this as default, either globally or pr git. Do a search on duckduckgo.com to figure out the current way.

Writing files/lines

  • All the lists needs to be in raw data form; from which other scripts easily can work with, without first have to run several cleanup processes.
  • All files most be formatted with a newline (\n)(LF) UTF-8.
  • All files have to be in universal UTF-8 style without BOM.
  • Filename containing _windows_ in it's name most be encoded in ISO-8859-1 Latin1 and newlines shall end be in (CRLF).
  • Line length should not be more than 80 chars for optimal terminals support, and a usage of 72 chars are optimal to include Unix (as they often has a screen offset of 8 chars to the right).
Version

Current version is 2021022501

Last Author
Spirillen
Last Edited
Feb 25 2021, 2:15 PM

Document Hierarchy

Event Timeline

Spirillen created this object.
Spirillen created this object with edit policy "Administrators".
Spirillen published a new version of this document.
Spirillen edited the content of this document. (Show Details)EditedFeb 25 2021, 2:15 PM
Spirillen added a project: Guides.
Spirillen added a subscriber: Guides.

@funilrys and @Somebodyisnobody do you have any comments for this rewrite before I release it?

Spirillen published a new version of this document.Mar 11 2021, 2:59 PM