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
delthas 4f876d81f3 trivial typo
2019-12-02 04:54:52 +00:00

1.5 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 advice if you are not sure. We don't bite.

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

Commits

  1. Prefix commit message with a package path if it affects only a single package.
  2. Provide reasoning for details in the source code itself (via comments), provide reasoning for high-level decisions in the commit message.
  3. Make sure every commit builds & passes tests. Otherwise git bisect becomes unusable.