mirrors/maddy
1
0
Fork 0
mirror of https://github.com/foxcpp/maddy.git synced 2025-04-04 05:37:34 +03:00
Code Issues Projects Releases Packages Wiki Activity
maddy/.github/CONTRIBUTING.md
Hexawolf 5031797192 Style and grammar update to Markdown files 
This commit majorly updates all Markdown documents by attempting to maintain a consistent (80 columns per line) formatting and addresses some display bugs in other Markdown renderers due to improper use of Markdown - GitHub is a little broken. But it also addresses grammar and even makes semantical changes to some paragraphs.

Notably, in README.md, section "System authentication helper binaries" had relatively severe changes.

To future contributors: if trying to maintain any kind of wrapping standard, I suggest using special extensions, like Rewrap for VSCode.
2019-10-21 19:41:13 +00:00

1.1 KiB
Raw Blame History

Contributing Guidelines

Of course, we love our contributors. Thanks for spending time on making maddy better.

Reporting bugs

Issue tracker is meant to be used only if you have a problem or a feature request. If you just have some questions about maddy - prefer to use the IRC channel.

  • Provide log files, preferably with 'debug' directive set.
  • Provide the exact steps to reproduce the issue.
  • Provide the example message that causes the error, if applicable.
  • "Too much information is better than not enough information".

Issues without enough information will be ignored and possibly closed. Take some time to be more useful.

See SECURITY.md for information on how to report vulnerabilities.

Contributing Code

  1. Use common sense.
  2. Learn Git. Especially, what is git rebase. We may ask you to use it if needed.
  3. Tell us that you are willing to work on an issue.
  4. Fork the repo. Create a new branch, write your code. Open a PR.

Ask for advise if you are not sure. We don't bite.

maddy design summary and some recommendations are provided in HACKING.md file.