Merge pull request #234 from Hoikas/contributing

Add contributing guide.

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+We are glad that you are interested in contributing to moul-assets! We happily accept contributions, including:
+- bug reports
+- bug fixes
+- art assets
+- and much more!
+
+Please take a moment to read these guidelines to ensure your contributions are accepted.
+
+## Project Goals
+The goal of the moul-assets project is to provide baseline assets for the MMORPG [Myst Online: Uru Live](https://mystonline.com) to be used in the [Plasma Engine](https://github.com/H-uru/Plasma). In the interest of doing so, we have identified these project goals:
+- providing a coherent, well-tested content baseline for [Myst Online: Uru Live](https://mystonline.com) shard operators
+- conservatively improving the base game Ages as created by Cyan Worlds, Inc. with objective bug fixes and enhancements
+- improving the player experience
+- integrating new content that serve a clear purpose in enhancing Myst Online: Uru Live as a video game
+- avoiding nontrivial breaks in compatibility with the official **Myst Online: Uru Live (again)** game run by Cyan Worlds, Inc.
+
+Further, we have identified these non-goals:
+- accepting all fan-created content
+- accepting fan-created content published on any particular shard, including the official **Myst Online: Uru Live (again)** game run by Cyan Worlds, Inc.
+- accepting fan content geared toward role-playing done on any particular shard, including the official **Myst Online: Uru Live (again)** game run by Cyan Worlds, Inc.
+- supporting exploit-based gameplay
+
+These are tasks that run contrary to the project's priorities stated above, and as such are not likely to be accepted if submitted for inclusion. Any changes implementing these are best maintained on an independent fork.
+
+## Getting Involved
+Real-time discussion with team members and other contributors is an excellent way to begin contributing. We welcome feedback and discussion of proposed changes. Active maintainers can be found on the Guild of Writers IRC channel:
+- Server: irc.guildofwriters.org:6667
+- Channel: #writers
+
+We also use the [Guild of Writers' forum](https://forum.guildofwriters.org/viewforum.php?f=3) for more permanent discussions. Further, many team members can also be found on the [OpenUru Discord](https://discord.com/invite/tVknpHQ).
+
+## Reporting Bugs and Requesting Features
+We use GitHub's [issue tracker](https://github.com/H-uru/moul-assets/issues) to list bugs and feature requests. Good bug reports tend to have:
+- a summary or background
+- steps to reproduce the bug, the more specific, the better!
+- what you expect to happen
+- what actually happens
+- any other pertinent notes, such as why you think the issue is happening and any mitigation you attempted
+
+## Submitting Changes
+Changes to moul-assets generally fall under two categories: objective and subjective. Before submitting any changes to the repository, you will need to [request access](https://guildofwriters.org/assets_repo) to the LFS store.
+
+### Submitting Objective Changes
+Objective changes tend to be limited in scope and are generally minor adjustments or fixes to content already accepted to the repository. These changes should require limited discussion and should demonstrate a clear and apparent improvement to the game. These changes may be developed and submitted using [GitHub Flow](https://guides.github.com/introduction/flow/index.html). To propose changes to the repository:
+- fork the repository and make your changes as described by GitHub flow
+- open a pull request and ensure that all test coverage and continuous integration passes
+- document in the pull request body what you have changed and why
+
+### Submitting Subjective Changes
+Subjective changes tend to be larger in scope and generally require discussions around myriad aspects of their development. This can be a lengthy process involving many revisions to your contribution. At this time, we are not interested in unsolicted submissions of new Ages. New Ages should be submitted to the individual Shard(s) that you would are interested in Age appearing on.
+
+Subjective changes to the game are, by their very nature, subjective, hence our reluctance to impose and document a specific review process. However, all subjective submissions should:
+- be relatively bug-free
+- be tested against the current H'uru version of the [Plasma Engine](https://github.com/H-uru/Plasma) by the creator (at minimum)
+- match the art style of the currently accepted content both visually and audibly
+- not look like a "video game"
+- have largely correct lighting

README.md

@@ -11,7 +11,7 @@ This repository is used to host assets used in Cyan World's Myst Online: Uru Liv
 You may notice while browsing this repository online or after cloning on your own machine that most files seem to be small text files containing some kind of hash reference. This is because the MOUL assets repository is too large for (free) GitHub. We therefore use an external Git Large File Storage server. The easiest way to download the entire repository is to use `git lfs clone`. Do keep in mind that the repository is very large (over 20GB), so make sure to run this command in a location with sufficient space. You may also choose to enable Git LFS by default. You can find some basic information on the [Git LFS website](https://git-lfs.com/) or refer to the [Git LFS wiki page on pulling and cloning](https://github.com/git-lfs/git-lfs/wiki/Tutorial#pulling-and-cloning).
 
 ## Contributing
-This repository is intended to track large binary files where diffs are impractical. All binary objects are stored on the Guild of Writers server to avoid incurring additional fees from GitHub. To prevent abuse/spam, the ability to push binary objects is restricted to approved users, even in your own fork. If you would like to contribute to this repository, you can request access [here](https://guildofwriters.org/assets_repo).
+This repository is intended to track large binary files where diffs are impractical. All binary objects are stored on the Guild of Writers server to avoid incurring additional fees from GitHub. To prevent abuse/spam, the ability to push binary objects is restricted to approved users, even in your own fork. If you would like to contribute to this repository, you can request access [here](https://guildofwriters.org/assets_repo). A more detailed [contributing guide](CONTRIBUTING.md) is available.
 
 ## Source Assets
 Source assets in this repository must be complete and in a format that is trivial to export or compile for the Myst Online version of the Plasma engine. Therefore, the sources must be one of the following: