mirrors/maddy
1
0
Fork 0
mirror of https://github.com/foxcpp/maddy.git synced 2025-04-05 05:57:39 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: Add HACKING.md link to CONTRIBUTING.md

Browse source
This commit is contained in:
fox.cpp 2019-09-28 13:22:45 +03:00
parent 2e3a11e3e5
commit e98ef4d1a7
No known key found for this signature in database
GPG key ID: E76D97CCEDE90B6C
1 changed files with 4 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
.github/CONTRIBUTING.md vendored
View file

@ -25,9 +25,7 @@ See SECURITY.md for information on how to report vulnerabilities.
2. Tell us that you are willing to work on an issue.
3. Fork the repo. Create a new branch, write your code. Open a PR.
Some hints regarding code design we would like to see:
- Generate a **small amount** of **useful** log messages.
- Generate **verbose** log messages with **'debug'** directive set.
- Create "modules" for **big** chunks of **reusable** functionality that may have
**swappable implementations**.
- Ask for advise regarding design if you are not sure. We don't bite.
Ask for advise if you are not sure. We don't bite.
maddy design summary and some recommendations are provided in
[HACKING.md](../HACKING.md) file.