Skip to content

Instantly share code, notes, and snippets.

@MattiDragon

MattiDragon/forking & porting policy.md

Created May 20, 2023 12:17
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save MattiDragon/6b9e71e8516447f53f0d5fb296ab8868 to your computer and use it in GitHub Desktop.
Save MattiDragon/6b9e71e8516447f53f0d5fb296ab8868 to your computer and use it in GitHub Desktop.
Download ZIP
My Forking & Porting Policy
Raw
forking & porting policy.md

My Forking & Porting Policy

In this gist I'll explain how I feel about others forking my mods, when it's ok and when I'd prefer it not be done. As most of my mods use open licenses such as the MIT and Apache license I have very little legal power to control forks, but I recommend you follow these guidelines regardless to keep a good relation with me and allow future collaboration.

Forking

If you want to fork my mods to play around with the code and learn, then feel free to do so without explict permission. You're also free to fork my mods if you do so intending to contribute to the original with a pull request, however, I recommend you discuss the changes you want to contribute with be beforehand. This allows me to know what you are doing so that I don't accidentally do the same work. Contacting me also helps you make better contributions as I can give recommendations on how thing should be done most efficently.

If you want to fork one of my projects and publish that fork without contributing back I ask you to first contact me. It's better for everyone if we don't have unnessesary forks. We can probably work out a way to integrate your changes into my version. If you do want to continue to maintain your own fork I have a couple of requests:

  1. Make it clear that I am not the maintainer of your fork: link to your own discord server and issue page. I don't want to deal with issues in your fork.
  2. Make it clear that your project is a fork of mine. I still want to retain credit for my work

Porting

I generally only maintain my mods for the latest versions. The supported versions of any of my mods should be available on the mods page. I'll only port changes that I deem important and see demand for to unsupported versions. Whole mods or major updates won't be backported by me, but I might accept pull requests.

I will not port my mods to forge, nor will I maintain forge ports created by others. If you want my mods on forge you are free to create a port yourself. Please contact me beforehand and read the policy on forks above. I try to support quilt on all of my mods, but I don't usually test support so it might occasionally break. If it does, please open an issue and I'll look into it. There's no need for a native quilt port.

If you have any questions, feel free to contact me on contant me in any way you see fit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment