Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 6.3 KB

CONTRIBUTING.md

File metadata and controls

102 lines (68 loc) · 6.3 KB
Raw

Contributing to Rspamd

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Rspamd and its packages, which are hosted in the Rspamd Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. This contribution policy is heavily inspired by Atom editor.

Table Of Contents

I don't want to read this whole thing, I just have a question

How Can I Contribute?

Styleguides

I don't want to read this whole thing I just have a question

Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.

We have an official site with a detailed FAQ and various community support resources.

The best way to ask a question and to get a relevant reply is the mailing list:

If chat is more your speed, you can join the Rspamd developers and users using Telegram or IRC:

Please bear in mind that even though tel is a chat service, sometimes it takes several hours for community members to respond — please be patient!

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Rspamd. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

How Do I Submit A (Good) Bug Report?

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Rspamd, e.g. which custom configuration are you using, or what message have you scanned. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • If you're reporting that Atom crashed, include a crash report with a stack trace from the operating system: https://rspamd.com/doc/faq.html#how-to-figure-out-why-rspamd-process-crashed
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of Atom) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of Atom? What's the most recent version in which the problem doesn't happen? You can download older versions of Atom from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • If the problem is related to scanning messages, does the problem happen for all messages or only some?

Include details about your configuration and environment:

  • Which version of Rspamd are you using?
  • What's the name and version of the OS you're using?
  • What hardware are you using, including CPU generation, e.g. Intel Haswell or ArmV7? If you have gcc installed, that could be achieved by the following command: gcc -march=native -Q --help=target|grep march. In Linux, you can also check /proc/cpuinfo file for the required details.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less (without tag)
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable tag:
    • [Minor] - minor issue/improvement not worth to mention in ChangeLog
    • [Feature] - a significant feature
    • [Fix] - bug fix
    • [CritFix] - critical bug fix
    • [Rework] - some significant logic rework
    • [Config] - configuration change
    • [Rules] - rules change

Lua styleguide

Please use the following Lua style guide when contributing changes to Lua code. This guide is both applicable for rules, libraries and plugins.