File: CONTRIBUTING.rst

package info (click to toggle)
breathe 4.12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,752 kB
  • sloc: python: 9,895; cpp: 1,434; makefile: 508; ansic: 154; sh: 50
file content (32 lines) | stat: -rw-r--r-- 1,208 bytes parent folder | download | duplicates (4)
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

Contributing
============

Firstly, thank you for making it this far. We really appreciate anyone who even
thinks about reporting an issue or helping out with the code or docs. It is kind
of you to take the time.

Please Provide an Example
-------------------------

If you're having trouble with how the contents of a particular Doxygen comment
or a particular set of code is being processed then please provide an example of
the in question.

Ideally as a pull-request with additions to the `examples/specific` folder but
feel free to provide the comment content in your issue instead.

It really helps to accelerate development if we have examples to work from.


Feel Free to Keep Reminding Me
------------------------------

Honesty time!

I am sorry that this is the case but I tend to get distracted and not give
Breathe the attention it deserves. Please do keep reminding me about your issue
if you would like it fixed. I'll try to be explicit if I really don't have the
time to fix it in the immediate future, but if I've made some vague promise to
look at it and you've heard nothing for 3 days then feel free to prod me again.
It will get fixed faster if you do and I promise not to get upset :)