BeermotorWB/fomod

FOMOD, a format for game-agnostic mod installers.

★ 1Forks 0MakefileGitHub ↗Compare

README

FOMOD

A game-agnostic mod installer format.

You can find the full documentation for this format at fomod.rtfd.io. For simple issues use our issue tracker at Github and for any discussion feel free to mail us at [email protected].

Contributing

Build Status

If you're not familiar with the terms used, we have a glossary at the end for you! Try hovering over the unknown words, that might help too.

  • Using git is no longer necessary since Github allows commiting directly with the web interface. Github has a pretty good guide on using their web interface.

  • Before submitting a pull request make sure to submit a ticket in the issue tracker and reference this ticket in the PR, so it can be discussed. Typos and other small changes are exempted.

  • Any pull requests have to pass the tests run on travis (see badge above). These tests consist on passing any examples (and the schemas themselves) through an xml linter.

  • Pull requests without a proper description will not be accepted.

  • For pull requests that modify the schemas themselves please mail us at [email protected] for discussion. These changes are subject to the current state of the project.

Glossary

Git
Git is a version control system. You can learn more about them and git here.
Commit
Committing modifications to files creates a snapshot of your project. This is incredibly useful if you ever need to revert changes, to look at who made some changes or to allow multiple people to work on something at the same time. Like we're doing!
Pull Request
Pull requests allow you to ask for a set of changes to another repository. You can learn more about them here.
Issues, Tickets and Issue Tracker
The issue tracker is the place where you can open a ticket aka issue. Use these to leave feedback and suggestions! You can learn more about them here.
Linting
Linting documents is simply checking for errors. In our case, we check for compliance with a specific set of rules to enforce (the schemas). You can learn more about it here.

Issues