PatchGuidelines

From Seven Kingdoms

Any and all contributions to this project are accepted, provided you meet certain guidelines.

1. It is best to have a git checkout to work on:
Example: $ git clone git://www.7kfans.com/7kaa.git
2. Make your changes to the source code.
3. Obtain diff for your patch. You can do so in a number of ways.

* git add + git commit + git format-patch
* git diff
* diff -u a/file.c b/file.c

4. Mail your patch to skfans-devel@lists.sourceforge.net. Make sure you have a real first and last name by which we can attribute the change to.
5. Jesse Allen (the3dfxdude) currently maintains the release repo. He will approve your patch (and if not available, other project managers could step in and approve the patch). The following are patch writing guidelines that you should really follow to make getting the change in work.

Patch Writing Guidelines

• Do not change the indentation style of a file. If it's tabs, use tabs. If it's three spaces, use three spaces.
• Use the commenting style of the file as best as you can.
• Do not go off and make changes for the sake of change. Keep the project goals in mind, and ultimately, the original design of the game. This game should always ultimately be Seven Kingdoms.
• If it's sloppy, poor judgement, or not completely thought out, or potentially controversial it will not go into the release repo.
• One patch file per every change.
• Try to clean up whitespace in a round-about way. If you send a patch changing a piece of code, and in other places cleans up alot of whitespace, it could be distracting from the original purpose. Try not send patches that are basically no-op whitespace (Like it better looking this way) changes either.

These guidelines are of course not to discourage you from trying things on your own. If something doesn't get accepted on your first try, try asking about it more in the forums or on the mailing list. If you can defend your change and there are some things that could be worked out for the benefit of all until the patch is accepted, you should consider publishing your git repo (look for public hosting sites). If your change is indeed important enough, we will try to get the community at large involved at a higher level.