Draft: Create pull request template #11
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| This repository is for usable OpenCiv3 game assets and their associated data only. To keep the repo clean, maintainable, and compliant with IP rights, please confirm the following: | ||
|
|
||
| # Prior or Modified Work | ||
| - [ ] I confirm that the assets contain no material derived from original game files or otherwise unlicensed copyrighted work except in cases of fair use. | ||
| - [ ] I have done my due diligence to confirm that any assets not original to me are freely redistributable under open-source compatible terms. | ||
| - [ ] I have included for each separately sourced asset or set of assets a corresponding co-located `credits.txt` file containing the source (URL if possible), any known license or attribution information, and if any modifications were made. | ||
|
|
||
| # Original Work | ||
| - [ ] I hereby grant free use of original assets I have created under [CC-BY-NC-4.0.](https://creativecommons.org/licenses/by-nc/4.0/) | ||
| - [ ] Any new image assets have been included in at least the largest usable in-game resolution and 32-bit PNG format, unless otherwise required. | ||
| - [ ] (Recommended) I have included the raw working files used to produce my assets, if any, preferably in a common free format such as GIMP, Audacity, or Blender files. | ||
|
|
||
| # General | ||
| - [ ] I have included only assets (or their corresponding metadata and working files) that are usable now in OpenCiv3, or will be usable with a current OpenCiv3 PR. No assets for future use only. | ||
| - [ ] I have checked [the wiki](https://github.com/C7-Game/pedia/wiki/Other-graphics) for recommendations before submitting new placeholder assets. | ||
| - [ ] Any assets which are generated by AI, or otherwise intended as placeholders, have been listed as such in `placeholders.md`. | ||
| - [ ] Any updated assets which are now considered production-ready have been removed from `placeholders.md`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Contributing assets to OpenCiv3 | ||
|
|
||
| This repository houses media assets used in OpenCiv3, a free open source game. Since these assets are of mixed origins and statuses, there is no singular license on the repository as a whole as explained in the [README](README.md). | ||
|
|
||
| Unless otherwise specified by the time of acceptance, contributors agree to provide their own work under the terms of [CC-BY-NC-4.0](https://creativecommons.org/licenses/by-nc/4.0/). They are free to also separately publish the same work under any other terms or license they wish. | ||
|
|
||
| In any case, OpenCiv3 must be permitted to freely use, redistribute, or modify any provided assets, regardless of the original source. This means that no content derived from non-free works such as commercial games may be submitted. | ||
|
|
||
| When contributing or updating assets, open a PR and complete the checklist of terms or call out any exceptions. | ||
|
|
||
| ## Selection of assets | ||
|
|
||
| Existing assets created by and for the Civ3 modding community are generally preferred, if there is something of sufficient quality and relevance. Lacking that, original or open-source compatible works are welcomed, with temporary placeholders as a last resort. | ||
|
|
||
| If opting to create original assets, creators should coordinate with the development team before doing significant work to agree on general characteristics, formats, etc. There is no need for original assets to conform to Civ3 formats and standards; for example 32-bit PNG is preferred for images. It is also strongly recommended that creators provide raw working files used to create the assets, to allow for easier customization. | ||
|
|
||
| New assets should not be submitted well in advance of when they are usable by the game, nor in speculation of alternative uses. We will integrate assets as the game is able to use them. If you have a proposal for a not yet available feature that would use new assets, coordinate with the development team first. | ||
|
|
||
| A list of specific placeholder assets that should be prioritized for replacement is maintained in [placeholders.md](placeholders.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Placeholders | ||
| This file lists assets that should be prioritized for replacement. Please keep it up to date and organized as you add or replace assets in this repository. | ||
|
|
||
| ## Low-quality placeholders | ||
|
Contributor
There was a problem hiding this comment. "Low-quality" is unnecessary here: a placeholder is a placeholder
Member
Author
There was a problem hiding this comment. True and I didn't care for the phrase myself, but I was trying to distinguish between "the literal name in a box" vs the "everything is a placeholder until we're satisfied" mentality. Another thing that could be elaborated on in the instructions.
Contributor
There was a problem hiding this comment. Maybe "Technical placeholders" or "Debug placeholders" or just "Labels" |
||
| * Art/Advisors/placeholder_leaderhead.png | ||
| * Art/Civilopedia/icons/units/unit_large.png | ||
| * Art/Civilopedia/icons/units/unit_small.png | ||
| * Art/Tech Chooser/Icons/placeholder.png | ||
| * Art/Units/units_32.png | ||
| * Art/city screen/buildings-large.png | ||
| * Art/city screen/buildings-small.png | ||
| * Art/Cursor.png | ||
|
|
||
| ## AI-generated | ||
| * Art/Animations/DisorderDefault.png | ||
| * Art/Cities/DESTROY.png | ||
| * Art/PalaceView/bkgr.png | ||
| * Art/SmallHeads/popHeads.png | ||
| * Art/SmallHeads/popupCULTURE.png | ||
| * Art/SmallHeads/popupDOMESTIC.png | ||
| * Art/SmallHeads/popupFOREIGN.png | ||
| * Art/SmallHeads/popupMILITARY.png | ||
| * Art/SmallHeads/popupSCIENCE.png | ||
| * Art/SmallHeads/popupTRADE.png | ||
| * Art/SpaceShip/SHIPbackground.png | ||
| * Art/Terrain/craters.png | ||
| * Art/WorldSetup/CLIMTEMPAGEDepress.png | ||
| * Art/WorldSetup/CLIMTEMPAGERollovers.png | ||
| * Art/WorldSetup/age.png | ||
| * Art/WorldSetup/climate.png | ||
| * Art/WorldSetup/landmassWaterSMALL.png | ||
| * Art/WorldSetup/landmassWaterSMALLdepress.png | ||
| * Art/WorldSetup/landmassWaterSMALLrollovers.png | ||
| * Art/WorldSetup/landmassWaterlarge.png | ||
| * Art/WorldSetup/temperature.png | ||
| * Art/city screen/luxuryicons_small.png | ||
| * Art/interface/box left color.png | ||
| * Art/interface/box right color.png | ||
| * Art/interface/box trans color.png | ||
| * Art/interface/menuButtons.png | ||
| * Art/interface/nextturn states color.png | ||
| * Art/resources.png | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd be keen for this file to be easily machine readable, as it makes scripting (coverage, etc.) easier.
The below structure is fine for this, I think, but maybe the format could be explicitly stated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea! It could be yml, which is meant to be easy to hand edit