Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 6.83 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 6.83 KB

Introduction

Hey there!

We are thrilled that you would like to help.

As a community pursuit, everything we do is motivated by passion. While we are not officially greenlit like with The Last Stand, with the right amount of persistence and a lot of patience, we aim to get out what we put in.

By participating, you agree to our Code of Conduct.

Contributor Guidelines

Coordination

In general, coordinate with us first to minimize the chance of your PR sitting in limbo. Fixes are cheap while our maintenance of them, and Valve's time spent verifying them, can be expensive. We value your time and rejection is a last resort, though sometimes the costs are unjustifiable or you may be overly ambitious.

We use lumps for I/O and other complex map fixes so please always open an issue for those cases. VScript fixes more specifically focus on Versus, clips we can easily move across modes depending on feedback, and easy reverts for Mutations or custom servers. Please discuss any new functions or globals with us before opening a VScript PR, since we may need to implement as a lump instead.

Please contact Lt. Rocky Lt. Rocky#7341 directly when it comes to model, animation, texture, or other source files. We store all source files separately and cannot accept them here.

If you are a VScripter or SourceModder, please contact someone here and ask about our L4D Scripting Discord server.

Submissions

Please follow the provided templates when submitting an issue (bugs, questions, and suggestions) or Pull Request (PR).

If in doubt, consider posting to this Steam forum thread instead.

Always search to see if an issue already exists before you open a new one. If you wish to help solve an existing issue that is not yet assigned to anyone, narrow down the search using the labels as filters to find one that interests you.

Things to keep in mind when it comes to changes:

  • Valve needs to verify every byte we edit, so maintenance tasks such as optimization and changelogs are the responsibility of maintainers.
  • Check if your file is already on the repo and, if not, please submit un-modified files from the live game as your earliest commits.
  • Usage of leading tabs are preferred over spaces for non-generated text files, as are VDF/KeyValue tokens enclosed in double quotes.
  • ByteOrderMark is not allowed for text files encoded with UTF-8.
  • Keep changes as focused as possible. If there are multiple changes that are not dependent on each other, consider a separate PR.
  • The least astonishing solution is probably the best one.
  • The amount of noise generated by a change can be inversely proportional to the complexity of the change - bikeshedding

When you submit your PR, enable the checkbox to allow maintainer edits so the branch can be updated for a merge. If it is not yet ready for review, please mark it as a draft. We will then review it and suggest changes or comment with questions. As you update your PR and apply changes, mark each conversation as resolved.

Resources

By forking a repository you make a copy of it for yourself that you can push changes to without affecting the original project. Forked repositories, or branches, are what you finally submit as a PR for review and merging.

About Pull Requests (PR's)
Getting started with Github Desktop
How to fork a repository with Github Desktop or command line
Linking a PR to an issue if you are resolving one
Searching issues and PR's
Writing good commit messages
Git tutorials for merge issues and a branching tutorial

Responsibility

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with our Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

On this repository, each category of content has a primary owner (or reviewer), even though we all try to wear different hats. You can address additional questions to: