Skip to content

Commit a5786a7

Browse files
committed
Added how to contribute section
1 parent ba85263 commit a5786a7

File tree

1 file changed

+104
-1
lines changed

1 file changed

+104
-1
lines changed
Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,105 @@
11
How to contribute
2-
=================
2+
=================
3+
4+
Found a bug? Have a new feature to suggest? Want to contribute changes to the codebase? Make sure to read this first.
5+
6+
Bug reporting
7+
-------------
8+
Your code doesn't work, and you have determined that the issue lies with Videoflow? Follow
9+
these steps to report a bug.
10+
11+
1. Your bug may already be fixed. Make sure to update to the current
12+
Videoflow master branch.
13+
14+
2. Search for similar issues. Make sure to delete `is:open` on the
15+
issue search to find solved tickets as well. It's possible somebody
16+
has encountered this bug already. Still having a problem? Open an issue on Github
17+
to let us know.
18+
19+
3. Make sure to provide us with useful information about
20+
your configuration: What OS are you using? What Tensorflow version are you using?
21+
Are you running on GPU? If so, what is your version of Cuda, of CuDNN?
22+
What is your GPU?
23+
24+
4. Provide us with a script to reproduce the issue. This script should
25+
be runnable as-is and should not require external data download
26+
(use randomly generated data if you need to test the flow in some data).
27+
We recommend that you use Github Gists to post your code.
28+
Any issue that cannot be reproduced is likely to be closed.
29+
30+
5. If possible, take a shot at fixing the bug yourself --if you can!
31+
32+
The more information you provide, the easir it is for us to validate that
33+
there is a bug and the faster we'll be able to take action.
34+
If you want your issue to be resolved quickly, following the steps
35+
above is crucial.
36+
37+
Requesting a Feature
38+
--------------------
39+
You can also use Github issues to request features you would
40+
like to see in Videoflow, or changes to the Videoflow API.
41+
42+
1. Provide a clear and detailed explanation of the feature
43+
you want and why it's important to add. Keep in mind that
44+
we want features that will be useful to the majority of our
45+
users and not just a small subset. If you are targeting
46+
a minority of users, consider writing and add-on library
47+
for Videoflow.
48+
49+
2. Provide code snippets demostrating the API you have in
50+
mind and illustrating the use cases of your feature.
51+
52+
3. After discussing the feature you may choose to attempt
53+
a Pull Request. If you are at all able, start writing
54+
some code. We always have more work to do than time to
55+
do it. If you can write some code then that will speed
56+
the process along.
57+
58+
Pull Requests (PRs)
59+
-------------------
60+
**Where should I submit my pull request?** Videoflow
61+
improvements and bug gixes should go to the Videoflow
62+
`master` branch.
63+
64+
Here is a quick guide on how to submit your improvements::
65+
66+
1. Write the
67+
code.
68+
69+
2. Make sure any new function or class you introduce has
70+
proper docstrings. Make sure any code you touch still
71+
has up-to-date docstrings and documentation. Use
72+
previously written code as a reference on how to format
73+
them. In particular, they should be formatted in MarkDown,
74+
and there should be sections for `Arguments`, `Returns` and
75+
`Raises` (if applicable).
76+
77+
3. Write tests. Your code should have full unit test coverage.
78+
If you want to see your PRs merged promptly, this is crucial.
79+
80+
4. Run our test suite locally. It is easy: from the
81+
Videoflow folder, simply run ``py.test tests/``
82+
83+
84+
5. Make sure all tests are
85+
passing.
86+
87+
88+
6. When comitting, use appropriate, descriptive
89+
commit messages.
90+
91+
7. Update the documentation. If introducing new functionality,
92+
make sure you include code snippets demonstrating the usage
93+
of your new feature.
94+
95+
8. Submit your PR. If your changes have been approved in
96+
a previous discussion, and if you have complete (and passing)
97+
unit tests as well as proper doctrings/documentation, your
98+
PR is likely to be merged promptly.
99+
100+
Adding new examples
101+
-------------------
102+
Even if you do not contribute to the Videoflow source code,
103+
if you have an application of Videoflow as is concise and
104+
powerful, please consider adding it to our collection of
105+
`examples <https://github.com/jadielam/videoflow/tree/master/examples>`_.

0 commit comments

Comments
 (0)