Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.22 KB

contrib.rst

File metadata and controls

33 lines (25 loc) · 1.22 KB

Contributing

Basic method to contribute a change

Dyndnsc is under active development, and contributions are more than welcome!

  1. Check for open issues or open a fresh issue to start a discussion around a bug on the issue tracker.
  2. Fork the repository and start making your changes to a new branch.
  3. Write a test which shows that the bug was fixed.
  4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS.

Idioms to keep in mind

  • keep amount of external dependencies low, i.e. if it can be done using the standard library, do it using the standard library
  • do not prefer specific operating systems, i.e. even if we love Linux, we shall not make other suffer from our personal choice
  • write unittests

Also, keep these 20 idioms in mind:

  1. Beautiful is better than ugly.
  2. Explicit is better than implicit.
  3. Simple is better than complex.
  4. Complex is better than complicated.
  5. Readability counts.