Skip to content

Instantly share code, notes, and snippets.

@Tsuey
Last active May 20, 2022 14:53
Show Gist options
  • Save Tsuey/745467633100015bb6b280b77765d394 to your computer and use it in GitHub Desktop.
Save Tsuey/745467633100015bb6b280b77765d394 to your computer and use it in GitHub Desktop.
CONTRIBUTOR_GUIDELINES.md

Introduction

Hey there!

We are thrilled that you would like to help. If you ever have a question it is probably addressed below; if not, please contact us.

As a community pursuit, everything we do is motivated by passion. Unlike The Last Stand, we are not officially greenlit for an update. However, we are not going to wait for life to happen to us. 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

Submissions

If you are just here to report a bug, then jump to our Code of Conduct.

If you are here to submit files, please first consider opening an issue to ask questions or discuss potentially subjective changes or improvements first.

Once you are ready to commit, you can start by forking (or copying) this repository, then you can create a branch with your changes. You may then request that your files be added by submitting your branch in a Pull Request or PR. You can read more about PR's here.

For every submission, please keep the following in mind:

  1. If the repository does not already have the script *.nut or text file *.txt/*.vmt, please submit the unchanged files as the earliest commits, then your changes.
  2. Please contact Lt. Rocky Lt. Rocky#7341 directly when it comes to model, texture, or other source files. We store all source files separately and cannot accept them here.
  3. Valve needs to verify every byte we edit, so every submission must serve some functional utility. Maintenance tasks such as optimization and changelogs are the responsibility of maintainers and owners.
  4. For readability, follow prominent format conventions if they have already been established. A good example is Valve's KeyValue format that encloses everything in double quotes. Optimization might not mean less bytes.
  5. Keep changes as focused as possible. If there are multiple changes that are not dependent on each other, consider a separate PR.
  6. Please mark PR's as drafts if they are not yet ready for review.
  7. Finally, write good commit messages.

Again: please consider opening up an issue for discussion pieces such as suggestions instead of submitting implemented suggestions outright.

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. In general this includes:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment