Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Port Contributing and Code of conduct guidelines from OpenRA/OpenRA #27

Closed
pchote opened this issue Jul 22, 2017 · 3 comments
Closed

Port Contributing and Code of conduct guidelines from OpenRA/OpenRA #27

pchote opened this issue Jul 22, 2017 · 3 comments
Milestone
First Bugfix Release

Comments

@pchote
Copy link
Member

pchote commented Jul 22, 2017

No description provided.

@pchote pchote added this to the First Bugfix Release milestone Jul 22, 2017
@pchote
Copy link
Member Author

pchote commented Aug 17, 2017 •
edited

I have made a start on a CONTRIBUTING.md for this repo taking some hints from https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md

Suggestions and comments are encouraged:

OpenRA Mod SDK Contributing Guidelines

Thank you for your interest in OpenRA, OpenRA modding, and the OpenRA Mod SDK. OpenRA is an open source project, and our community members – you – are the driving force behind it. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into OpenRA, the Mod SDK, or our other sub-projects.

Please note that this repository is specifically for the scripts and infrastructure used to develop and build mods; bugs and feature requests against OpenRA itself should be directed to the main OpenRA/OpenRA repository. If you do come across a bug with the Mod SDK, or would like to request a new feature, then please take a look at the issue tracker first to see if it has already been reported.

When developing new features, it is important to make sure that they work on all our supported platforms. Right now, this means Windows >= 7, macOS >= 10.7, and Linux. We would like to also support *BSD, but do not currently have a means to test this.

Some issues to be aware of include:

  • Use http://www.shellcheck.net/ to confirm POSIX compatibility of *.sh scripts.
  • Avoid non-standard gnu extensions to common Unix tools (e.g. the -f flag from GNU readlink)

While your pull-request is in review it will be helpful if you join IRC to discuss the changes.

See also the in-depth guide on contributing on the main OpenRA project wiki. Most of the content on this page also applies to the Mod SDK.

@reaperrr
Copy link

reaperrr commented Aug 17, 2017 •
edited

A sentence or two here about identifying bugs and filing reports

My suggestion:

If you come across a bug, please give our issue tracker a look first to see if someone else already reported the bug you encountered. If that doesn't appear to be the case, we recommend using our template to file a report: link to template

@pchote
Copy link
Member Author

pchote commented Aug 22, 2017

Fixed by b66892e.

@pchote pchote closed this as completed Aug 22, 2017
penev92 added a commit to penev92/OpenRAModSDK that referenced this issue Jun 23, 2022
@penev92
Update Apolyton to OpenRA release-20210503 (OpenRA#27)
e5576d5 
* Updated ModSDK scripts to release-20200503

* Added artwork placeholders; moved existing logos

* Updated the .gitattributes file

It now matches the .gitattributes files of both the ModSDK and OpenRA.
EoL changes were introduced to OpenRA with PR 15274
and merge strategies were removed from OpenRA with PR 16451

The ModSDK .gitattributes file was initially created like this.

* Updated ModSDK scripts from "release-20200503" to "release-20210321"

 - Removed `.travis.yml`  based on ModSDK PR 170 - "Compatibility/feature upgrades for playtest-20201213" ("Update scripts, packaging, and example mod for playtest-20201213").
 - Updated `fetch-engine.sh` based on ModSDK PR 169 - "Fix a collection of minor issues" ("Update python requirement").
 - Updated `launch-dedicated.cmd` based on ModSDK PR 170
 - Updated `launch-dedicated.sh` based on ModSDK PRs 169 and 170
... and so on.

* Updated OpenRA.Mods.Example.csproj

* Manual updates PART 1 - mod.yaml Packages and Assemblies

Following instructions at https://github.com/OpenRA/OpenRAModSDK/wiki/Update-notes:-Release-20200503-to-Release-20210321
Mirroring OpenRA PR 18846 - "Add a bin directory for generated binaries" ("Replace ^ and . in platform paths with ^SupportDir and ^EngineDir." + "Output compiled binaries to ./bin.")

* Manual updates PART 2 - spawn disabling

Following instructions at https://github.com/OpenRA/OpenRAModSDK/wiki/Update-notes:-Release-20200503-to-Release-20210321
Necessitated by OpenRA PR 18425 - "Add ability to right click on map to disable spawn points".

* Manual updates PART 4 - metrics.yaml

Following instructions at https://github.com/OpenRA/OpenRAModSDK/wiki/Update-notes:-Release-20200503-to-Release-20210321
Taken from OpenRA PR 18633 - "Move shared sound and color definitions to common metrics".

* Manual updates PART 5 - dropdowns and scrollpanels

Taken from OpenRA PR 17663 - "Unify widget state image names (disabled, pressed, hover, focused)".

* Temporarily removed maps with custom rules

As they had issues with referenced rules files and break the utility when it tries to update the mod.

* Ran the utility to automatically update the mod to version release-20210321

* Keep personalized `launch-launch-dedicated.cmd`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
First Bugfix Release
Development

No branches or pull requests
2 participants
@pchote @reaperrr