PageRenderTime 11ms CodeModel.GetById 1ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/source/dev/contributing.rst

https://bitbucket.org/prologic/circuits/
ReStructuredText | 53 lines | 31 code | 22 blank | 0 comment | 0 complexity | f799bd494a07ed0f501b7edef7343a1e MD5 | raw file
 1Contributing to circuits
 2========================
 3
 4Here's how you can contribute to circuits
 5
 6
 7Share your story
 8----------------
 9
10
11One of the best ways you can contribute to circuits is by using circuits.
12Share with us your story of how you've used circuits to solve a problem
13or create a new software solution using the circuits framework and library
14of components.
15
16.. see: http://circuitsframework.com/Community
17
18
19Submitting Bug Reports
20----------------------
21
22
23We welcome all bug reports. We do however prefer bug reports in a clear
24and concise form with repeatable steps. One of the best ways you can report
25a bug to us is by writing a unit test (//similar to the ones in our tests//)
26so that we can verify the bug, fix it and commit the fix along with the test.
27
28To submit a bug report, please use:
29 http://bitbucket.org/circuits/circuits/issues
30
31
32Writing new tests
33-----------------
34
35
36We're not perfect, and we're still writing more tests to ensure quality code.
37If you'd like to help, please `Fork circuits <https://bitbucket.org/circuits/circuits/fork>`_, write more tests that cover more of our code base and
38submit a `Pull Request <https://bitbucket.org/circuits/circuits/pull-request/new>`_. Many Thanks!
39
40
41Adding New Features
42-------------------
43
44
45If you'd like to see a new feature added to circuits, then we'd like to hear
46about it~ We would like to see some discussion around any new features as well
47as valid use-cases. To start the discussions off, please either:
48
49- `Chat to us on #circuits on the FreeNode IRC Network <http://freenode.org>`_
50
51  or
52
53- `Submit a **New** Issue <http://bitbucket.org/circuits/circuits/issues>`_