Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.71 KB
Raw

Contributing

I appreciate your interest in contributing to this project. Please review the general process and scope before starting a contribution.

Scope

The four main requirements for this project are:

  1. Start a Half-Life dedicated server easily with Docker.
  2. Have the ability for users to install custom plugins, maps and server configurations by providing a way to manipulate the server directory. Commonly used server plugins are intentionally not provided as a default, which is considered a user concern.
  3. Have the ability to run servers for custom mods.
  4. Only support legal usage of Steam and Valve's titles. It will not, and never will, support the ability to circumvent any licensing or other restrictions Valve imposes. The project maintainers will report any shady behaviour to Valve and/or GitHub.

Process

  1. File an issue on the Issue board, or create a discussion on the Discussions board.
  2. Once discussed and agreed upon, clone the project and base your changes on the beta branch.
  3. Make your changes.
  4. Validate your changes; at the very least, please build the image and start a server. You can learn how to build the images using the guide located here.
  5. Submit a pull request to the beta branch.
  6. Once reviewed, your changes will be made available on DockerHub via the -beta tag, for example jives/hlds:cstrike-beta.
  7. After some more tests, changes will be merged into the main branch where the production images will be published. This step will be performed by a project maintainer.