Skip to content
This repository has been archived by the owner on Oct 27, 2021. It is now read-only.

Latest commit

 

History

History
57 lines (42 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 2.25 KB
Raw

Contributing to Xash3D SDL

Third-party patches for Xash3D SDL are great idea. But if you want your patch to be accepted, we can give you few guidelines.

If you are reporting bugs

  1. Check you are using latest version. You can build latest Xash3D for yourself, look to README.md.
  2. Check open issues is your bug is already reported and closed issues if it reported and fixed. Don't send bug if it's already reported.
  3. Now you can write bugreport.
  4. Write down steps to reproduce bug.
  5. Write down OS and architecture you are using.
  6. Re-run engine with -dev 5 -log arguments, reproduce bug and post engine.log which can be found in your working directory.
  7. Attach screenshot if it will help clarify the sitation.
  8. Wait for answer.

If you are contributing code

Which branch?

  • We recommend using master branch. But you still can use any of our branches, if they are up-to-date.

Third-party libraries

  • Philosophy of any Xash Project by Uncle Mike: don't be bloated. We follow it too.
  • There is allowed only these libraries, which is used in Linux GoldSrc version or if there is a REAL reason to use library.

Portability level

  • Xash3D have it's own crt library. It's recommended to use it. It most cases it's just a wrappers around standart C library.
  • If your feature need platform-specific code, try to implement to every supported OS and every supported compiler.
  • You must put it under appopriate macro. It's a rule: Xash3D SDL must compile everywhere.
OS Macro
Linux defined(__linux__)
FreeBSD defined(__FreeBSD__)
NetBSD defined(__NetBSD__)
OpenBSD defined(__OpenBSD__)
OS X/iOS defined(__APPLE__) and TargetConditionals macros
Windows defined(_WIN32)
Android defined(__ANDROID__)
Emscripten defined(__EMSCRIPTEN__)

Licensing

  • Look COPYING file in repository, if you are unsure.

Code style

  • This project uses Quake's C code style convention.
  • In short:
    • Use spaces in parenthesis. Even in empty.
    • Use tabs, not spaces, for indentation.
    • Any brace must have it's own line.
    • Short blocks, if statements and loops on single line is allowed.
  • You can use clang-format here. Config is located in .clang-format file in repository's root .