# Contributing to Rspamd :tada: First off, thanks for taking the time to contribute! :tada: The following is a set of guidelines for contributing to Rspamd and its packages, which are hosted in the [Rspamd Organization](https://github.com/rspamd) 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](https://github.com/atom/atom). #### Table Of Contents [I don't want to read this whole thing, I just have a question](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question) [How Can I Contribute?](#how-can-i-contribute) * [Reporting Bugs](#reporting-bugs) [Styleguides](#styleguides) * [Git Commit Messages](#git-commit-messages) * [Lua style guide](#lua-styleguide) ## 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. * [Support channels explained](https://rspamd.com/support.html) * [Rspamd FAQ](https://rspamd.com/doc/faq.html) The best way to ask a question and to get a relevant reply is the mailing list: * [Join Rspamd mailing lists](https://lists.rspamd.com/) If chat is more your speed, you can join the Rspamd developers and users using Telegram or IRC: * [Join Rspamd telegram channel](http://t.me/rspamd) * [Join Rspamd IRC channel](https://freenode.net/): * server: irc.freenode.net (port 6666) * channel: #rspamd 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 :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). 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 * Read about bug reporting in general: https://rspamd.com/doc/faq.html#how-to-report-bugs-found-in-rspamd * Enable relevant debugging logs: https://rspamd.com/doc/faq.html#how-to-debug-some-module-in-rspamd * Check the FAQs about Core files in case of fatal crash: https://rspamd.com/doc/faq.html#how-to-figure-out-why-rspamd-process-crashed * Check that your issue isn't already filed: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+user%3Arspamd * Check that there is not already an experimental package or master branch #### 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](https://help.github.com/articles/markdown-basics/#multiple-lines). * **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](https://github.com/atom/atom/releases). * **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](lua_style.md) when contributing changes to Lua code. This guide is both applicable for rules, libraries and plugins. de-signing-crl'>automated/noid/stable23-update-code-signing-crl Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
summaryrefslogtreecommitdiffstats
path: root/build/integration/features/comments.feature
blob: 0ee11bc9873877eda0e5cbf3d8880cb99dce1e4f (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209