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
|
.. _Fork circuits: https://github.com/circuits/circuits/issues/new#fork-destination-box
.. _Create an Issue: https://github.com/circuits/circuits/issues/new
.. _Pull Request: https://github.com/circuits/circuits/compare/
Contributing to circuits
========================
Here's how you can contribute to circuits
Share your story
----------------
One of the best ways you can contribute to circuits is by using circuits.
Share with us your story of how you've used circuits to solve a problem
or create a new software solution using the circuits framework and library
of components.
.. see: http://circuitsframework.com/Community
Submitting Bug Reports
----------------------
We welcome all bug reports. We do however prefer bug reports in a clear
and concise form with repeatable steps. One of the best ways you can report
a bug to us is by writing a unit test (//similar to the ones in our tests//)
so that we can verify the bug, fix it and commit the fix along with the test.
To submit a bug report, please `Create an Issue`_
Writing new tests
-----------------
We're not perfect, and we're still writing more tests to ensure quality code.
If you'd like to help, please `Fork circuits`_, write more tests that cover more
of our code base and submit a `Pull Request`_. Many Thanks!
Adding New Features
-------------------
If you'd like to see a new feature added to circuits, then we'd like to hear
about it~ We would like to see some discussion around any new features as well
as valid use-cases. To start the discussions off, please either:
- `Chat to us on #circuits on the Libera.Chat IRC Network <https://libera.chat>`_
or
- `Create an Issue`_
|
