There's a little too much junk in the CONTRIBUTING file. I feel like it's unnecessary to say some of the things that were being said in there. It really needs to be to the point
46 lines
2.2 KiB
Text
46 lines
2.2 KiB
Text
Bug Tracker: https://obsproject.com/mantis/
|
|
|
|
Forum accounts are linked to mantis bug tracker.
|
|
|
|
Contributing:
|
|
|
|
- Code and commits will be reviewed. Reviews will be blunt and honest, and
|
|
your change probably won't go through the first time, or may be outright
|
|
rejected. It may require many revisions before changes are finally
|
|
accepted.
|
|
|
|
- If you want to avoid doing a lot of work only to have it rejected, discuss
|
|
what you want to change it in the main channels/forums/mailing lists before
|
|
actually working on it. Open source requires thick skin. Please don't be
|
|
discouraged if your changes don't go through, learn from it and get better.
|
|
|
|
- If you don't quite know what to work on and just want to help, the bug
|
|
tracker has a list of things that need to be worked on.
|
|
|
|
- Try to respect the wishes of the author(s)/maintainer(s). A good maintainer
|
|
will always listen, and will often ask others on the project for their
|
|
opinions, but don't expect things to be completely democratic.
|
|
|
|
- Coding style is Linux-style KNF (kernel normal form). This means K&R, 80
|
|
columns max, preferable maximum function length of approximately 42 lines, 8
|
|
character width tabs, lower_case_names, etc. I chose this for the sake of
|
|
the project. Don't argue about it, just do it. It takes no time to do.
|
|
|
|
See https://www.kernel.org/doc/Documentation/CodingStyle for a general
|
|
guideline (though not necessarily a rulebook, for example we allow the use
|
|
of boolean return values instead of ints for failure).
|
|
|
|
NOTE: C++ is an exception to the lower_case_only rule, CamelCase is
|
|
encouraged (though not required) to distinguish it from C code. Just a
|
|
personal and subjective stylistic thing on my part.
|
|
|
|
- Core code is C only (unless there's an operating system specific thing that
|
|
absolutely requires another language).
|
|
|
|
- Modules and UI may use C, C++, or Objective-C (for apple), though please try
|
|
to use C unless an API you're using requires C++ or Objective-C (such as
|
|
windows COM classes, or apple Objective-C APIs).
|
|
|
|
- Do not use dependencies for the sake of convenience. There's enough
|
|
dependencies as it is. Use them only if you absolutely have to depend on
|
|
them.
|