Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

115 lines (80 loc) · 4.28 KB
Raw

Contributing

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 or rewrite for broader support of bash environments across OS's

  2. You can add domains to either the submit_here folder of this repo.

  3. Please add you contribution to either the vary beginning of the file or the bottom, the CI/CD will do the sorting.

Workflow

My Privacy DNS Firewall

Add new hosts

The workflow is a bit clumsy, but the most reliable and fail-safe.

  1. You add an issue with you question, feature request or contribution via this form (This is the history of why to block forum)

  2. Add your new domain record(s) to suitable file in the submit_here/ folder on GitHub. A Maniphest ticket is required to be able to historically trace why you have committed the records.

  3. You open a PR (Pull (Merge) Request) where you'll add your contribution (This is the when we did the block)

  4. You add the new hosts entry in the top of the list, then it is easier to find.
    The code will make it appear in alphanumeric order

  5. Follow the New commit guide

Github

Add new hosts

The workflow is a bit clumsy, but the most reliable and fail-safe.

  1. You add an issue with you question, feature request or contribution via this form (This is the history of why to block forum)

  2. You open a MR (Merge Request) where you'll add your contribution (This is the when we did the block)

  3. Add your new domain record(s) to suitable file in the submit_here/ folder on GitHub. A Maniphest ticket is required to be able to historically trace why you have committed the records.

  4. You add the new hosts entry in the top of the list, then it is easier to find.
    The code will make it appear in alphanumeric order

  5. Follow the New commit guide

New code

If you like to add new code or modify existing code to make it run better, faster, smarter etc. You will by editing and contributing to the code, automatically be redirected to a fork of the main repo, from where you add and/or modify the code.

New commit

When you are done with your contribution, you will save the the file in a new branch. Don't forget to make a full reference to the Maniphest issue in your commit message as:

  1. T$ID
  2. https://www.mypdns.org/T`$ID`

Replace the $ID with the issue id from https://www.mypdns.org/maniphest/

new commit

Next you'll be taken to the Open a pull request

Open a pull request

And if everything is filled out, you just hit the Create pull request and you are done.

GPG signed

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

Only exception to this rule is the CI/CD bot

How do I sign with GPG

If you know nothing about GPG keys I really suggest you search on duckduckgo for the best way to do it, on your current OS.

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

Encoding when writing files/lines

  • All files most end with a newline \n(LF) UTF-8.
  • All files have to be in universal UTF-8 style without BOM
  • Any files or file location containing _windows_ in it's files must be encoded in ISO-8859-1 Latin1 and newlines most end in (CRLF)
  • Line length should not be any longer than 80 chars for supporting terminals.

(This version supersedes https://www.mypdns.org/w/contributing/)

Revision date: 04. September 2020.

Last edited by: https://www.mypdns.org/p/Spirillen/

Approved by: https://www.mypdns.org/p/Spirillen/

Version: rPD 1.1-alpha