Skip to content

Conversation

@Anixx
Copy link
Contributor

@Anixx Anixx commented Feb 15, 2025

No description provided.

@m417z
Copy link
Member

m417z commented Feb 15, 2025

In this and your other submissions of other's mods, have you tried contacting the authors and get them to submit the mods themselves? The readme is explicit about the author and the license, so I see no fundamental problem here, but I just think that it'd be better for the original authors to submit and maintain their own mods. If they explicitly say that they don't want to be bothered, then sure, you can maintain it on their behalf.

@valinet That's your mod, any thoughts about it?

@valinet
Copy link

valinet commented Feb 17, 2025

@m417z Do you plan on introducing 'third party repositories' support in Windhawk (in one form or another, that's another discussion) or you'd rather keep everything centralized, as it is now? What's the philosophy of Windhawk on this matter? Thanks.

@m417z
Copy link
Member

m417z commented Feb 17, 2025

That's the first time third party repositories are brought up. While I didn't give it much thought, I don't see much value in it for users or developers. For users, I think that a single, centralized place for mods with verified authors makes using Windhawk much easier. For developers, it requires creating a pull request for each mod release, which I don't think is too demanding. For drafts and experiments, the code can always be shared to bypass the official store.

Why would you prefer third party repositories in Windhawk? Is there a reason for you to prefer not submitting your mods here instead?

If Windhawk ever becomes so popular that managing the mods in a single repository becomes a problem, third party repositories can be considered, perhaps similarly to Linux apt.

@Anixx
Copy link
Contributor Author

Anixx commented Feb 19, 2025

Fron a contrubuting user's perspective, third-party repositories can be convenient because in this case the user can make pull requests directly to the repository. In current situation only the mod author can contribute. Also, separate repositories can serve as a substitute for categories, uniting mods dedicated to a specific topic or modesets.

On the other hand, trirdparty repos may not necessary have all the needed checks set up, and any glitches that would arise from this would be blamed on Windhawk as a whole.

@m417z
Copy link
Member

m417z commented Feb 19, 2025

in this case the user can make pull requests directly to the repository

It can already be done. Here's one example:

// Source code is published under The GNU General Public License v3.0.
//
// For bug reports and feature requests, please open an issue here:
// https://github.com/m1lhaus/windhawk-mods/issues
//
// For pull requests, development takes place here:
// https://github.com/m1lhaus/windhawk-mods

Discussion, development, and test versions can be managed in an external GitHub/GitLab/etc. repository or any other website. Then, when there's enough content for a new release, a pull request can be submitted to the official repository. It seems to be working well for everybody so far, and currently I see no reason to look for alternatives or improvements in this area.

separate repositories can serve as a substitute for categories, uniting mods dedicated to a specific topic or modesets

That's a different issue that can be addressed with tags, folders, more advanced filters, or similar approaches (ramensoftware/windhawk#113). Using different repositories for categories is IMO an overkill, and in any case not the intention here since there can be different mod authors for each category.

@Anixx
Copy link
Contributor Author

Anixx commented Feb 19, 2025

How is this possible if the build checks require the commit to originate from the mod's author? The checks would fail. You are the owner of the repo, so commits from you pass the checks. The other users only can commit to their own mods.

@m417z
Copy link
Member

m417z commented Feb 19, 2025

The original author is still the one who submits new versions to the official repository. But everybody can submit pull requests to the author's repository.

         Contributors
          │        │
          ▼        ▼
    ──┬───────────────────┬──► Mod author's repo
      │                   │
    v1.0                v2.0
      │                   │
      ▼                   ▼
ramensoftware/      ramensoftware/
 windhawk-mods       windhawk-mods

That addresses your statement that "In current situation only the mod author can contribute". I see it as a good thing that each author takes full responsibility for their mods. What's the alternative?

@Anixx
Copy link
Contributor Author

Anixx commented Feb 19, 2025

This has two problems:

  1. The author's repository usually gets deleted after their mod is submitted to the repo
  2. Even if it is not deleted, it goes unsync with the Windhawk repo and SRs from it become unmergeable. Even if the changes in the main repo affect other files, unrelated to the mods folder.

I have already encountered with this: when people submitted changes to my branch and I approve them, they still cannot be merged to the main repo, and I have to branch the needed file from the repo anew and manually copy and paste the proposed by the other user changes to it.

@m417z
Copy link
Member

m417z commented Feb 19, 2025

  1. The author's repository usually gets deleted after their mod is submitted to the repo

That's up to the author, who might be uninterested in contributions, or might decide to stop maintaining the mod completely. If the author is interested in contributions, they can keep or re-create the repo.

  1. Even if it is not deleted, it goes unsync with the Windhawk repo and SRs from it become unmergeable. Even if the changes in the main repo affect other files, unrelated to the mods folder.

That's a matter of knowing how to use git. Unfortunately, it can be cumbersome to do it directly from GitHub's web interface sometimes, but it's the most popular git service, and is probably the best platform overall. The upside is that because GitHub is so popular, there are guides for just about everything.

@RibShark
Copy link
Contributor

The trouble with the current system is that you have to fork the entire repo to submit a new mod; this is cumbersome and I'd quite like to be able to have any mods I create have their own git repositories so they can have their own readme.md/issues/etc without all the added cruft of the other, existing mod files/scripts/etc. Not to mention that there are a fair few people who prefer to not use GitHub at all for reasons such as AI scraping.

@m417z
Copy link
Member

m417z commented Mar 22, 2025

@RibShark What I was trying to say in my previous messages is that you can do that. You can have a repo that has only your mod(s), your own files/scripts/readme/etc. I, myself, have a separate repo for developing my mods, which I could also host on GitLab, Dropbox, or any other place:
https://github.com/m417z/my-windhawk-mods

The interaction with this repository is only needed when releasing a new version, which usually doesn't happen that often. Instead of this repository, I could also have some form on, say, https://windhawk.net/submit-new-mod, with a "Browse..." button to upload the new version source code. But then I wouldn't have a way to leave comments on the code and discuss the submission, which is something GitHub provides nicely, and many developers are already familiar with it.

Maybe I can have a simplified submission form that integrates with GitHub, something similar to this:
https://new-issue.ant.design/
It isn't top priority among the things in my TODO list regarding Windhawk, but I'll keep it in mind, perhaps it can help some people who are less familiar with git or GitHub.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants