-
Notifications
You must be signed in to change notification settings - Fork 9
Contributing
This page describes how to contribute to the Minecraft Archive. It assumes you have a basic knowledge of how to use git and how to write YAML, and that you have already read the pages about the metadata format and IPFS.
Before contributing, please be sure you read this entire page, as it contains several guidelines on how to contribute properly.
To get started contributing to the archive, you should first fork this repository. Any contributions you would like to make to the archive should be done on your own fork of the repository. We also ask that you try to make separate branches and pull requests for each distinct change you make to the archive. So, for example, do not add or modify several different mods in a single pull request unless the changes you are making are somehow related to each other (say, for example, if you're adding a mod and some other mod that it depends on).
Before you make your pull request, be sure you have added any newly archived files to your IPFS node, and that your IPFS node is running. When your changes are merged, one of the developers will need to pull the archived files from your IPFS node, which they can not do if it isn't running. See the page about IPFS for more information.
Please observe the following guidelines when making contributions to the archive.
- YAML filenames should be all lower case, and should never contain spaces. Shorter names are preferred, as they make the URLs shorter.
- Please try not to make several commits with small changes. Your PR should have as few commits as possible. If you're confident enough in your git abilities, you can use git rebase to squash your commits together.
- Please don't make changes against severely outdated versions of the repository.
If you have any questions about contributing, or you just want to chat with us for some reason, you can find us on the #mc-archive channel on the MultiMC Discord server.