search

snozbot / fungus

An easy to use Unity 3D library for creating illustrated Interactive Fiction games and more.
MIT License
1.64k stars 292 forks source link

Contributing in terms of overall code betterment (like cutting down on side effects) #747

Open CG-Tespy opened 5 years ago

CG-Tespy commented 5 years ago

I've been trying to work on a certain save-system-related feature just for my game. Looking through the save system's source code, I noticed quite a bit that could be improved in terms of things like side-effect-reduction. I'd like to contribute to making the code have less side effects.

That isn't contributing a new feature, though, so I'm unsure what I should do before making a pull request (besides making sure the already-implemented tests run locally). The stuff in the Contributing section only mentions rules for actual new features, so yeah.

chrisgregan commented 5 years ago

I recently removed the tests as the Unity Test Tools framework was deprecated a long time ago and no longer works in modern versions of Unity. Instead I suggest running the example scenes to test your changes and feel free to add more example scenes. Ideally I'd develop a new set of automated tests but I don't have much time these days to work on the project unfortunately. I do review all PRs that are sent in though it might take a while to get feedback. Bug fixes and refactors are very welcome. Bear in mind that people may be upgrading from an older version of Fungus so avoid unnecessary breaking changes if you can. Cheers!

CG-Tespy commented 5 years ago

Understood, thank you :)