source-sdk-2013-mapbase/.github/CONTRIBUTING.md
Blixibon 6ba3cd4c03
GitHub community issue/contribution changes (#75)
Overhauled Mapbase's GitHub-specific files to be more effective and project-agnostic

* Moved CONTRIBUTING to .github so it can be recognized as contribution guidelines
* Added more issue templates and made them more project-agnostic for forks
* Renamed issue templates so "Bug report", "Feature request", etc. come first when looking for the right template
* Added pull request template
2020-12-22 10:13:07 -06:00

2.3 KiB

This file details how to contribute to the Mapbase project on GitHub: https://github.com/mapbase-source/source-sdk-2013

For the original Source SDK 2013 contribution guidelines, click here: https://github.com/ValveSoftware/source-sdk-2013/blob/master/CONTRIBUTING


Mapbase is a project which many Source modders draw from, so it has its own unique standards for contributions which differ from other projects, but it is still an open-source repository that is always open to contributions.

Whenever you contribute to the Mapbase repository, you must keep in mind that any contributions made could be deployed to all mods utilizing Mapbase, which can include everything from high-profile Steam mods to amateur HL2 maps. Many contributions can also end up being available in both SP and MP if the contributions are not obviously exclusive to one of the two.

All contributions must follow the following rules:

  • A contribution must be aligned with Mapbase's goals and priorities and should not be "subjective" or related to a specific mod or type of mod. For example, fixing an existing issue or adding a new tool for mappers to use is usually fine, but adding a new custom weapon with its own assets is usually not fit for Mapbase.

  • All content in a contribution must be either already legally open-source or done with the full permission of the content's original creator(s).

  • Contributions must not break existing maps/content or interfere with them in a negative or non-objective way.

  • Code contributions are not obliged to follow Mapbase's preprocessor conventions (e.g. #ifdef MAPBASE), although following them is usually acceptable.

  • If you are contributing a file you created yourself specifically for Mapbase, you are required to use the custom "Mapbase - Source 2013" header used in other Mapbase files as of Mapbase v5.0. You are encouraged to append an "Author(s)" part to that header in your file in order to clarify who wrote it.

If your contribution is accepted, you may be listed in Mapbase's credits and the README's external content list: https://github.com/mapbase-source/source-sdk-2013/wiki/Mapbase-Credits#Contributors https://github.com/mapbase-source/source-sdk-2013/blob/master/README

You may also receive the "Contributor" or "Major Contributor" role on Mapbase's Discord server if you are a member of it.