Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fix contribution form #1

Open
Noggog opened this issue Aug 16, 2023 · 2 comments
Open

Add fix contribution form #1

Noggog opened this issue Aug 16, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@Noggog
Copy link
Member

Noggog commented Aug 16, 2023

Might be nice for users to be able to submit a fix via the website.

This will do a few things:

  • Associate the fix with a nexus account, or at least allow us to pull some info of who is submitting it
  • If they also (Log into Github #2 ), then we can pull info from that.
  • Allow for some blurbs on "best practices", and outline the ways users can submit fixes
  • If Spriggit ends up being used, then the website would be a portal to intake raw esp files.
    • Have a server run spriggit and initiate a text-based PR for the user
    • We can attach any descriptions/burbs taken from the websites intake forms
    • if Github is logged in, or the github email provided, then maybe the PR can add that as an additional author? (Would have to research how those additional author systems work)

Overall, would help a lot with accepting fixes from people intimidated by actually interacting with Git, or people that just want to work with raw esps on their side

@Pickysaurus
Copy link
Member

I've found a possible means to store files submitted via the site - https://vercel.com/docs/storage/vercel-blob

I'd have to learn how to set it up properly though.

@Pickysaurus Pickysaurus added the enhancement New feature or request label Sep 27, 2023
@Noggog
Copy link
Member Author

Noggog commented Sep 28, 2023

For people cloning Git repos directly, committing, and opening PRs like a developer, this whole issue will be N/A

This issue is mainly for the crowd that is grabbing our new nightly releases:
https://github.com/Starfield-Community-Patch/Starfield-Community-Patch/releases/tag/nightly

This crowd is the one not familiar with using git too much. They go and grab that nightly release as they just want the latest version nice and easy, without dealing with Git, Spriggit, etc.

This same crowd will be ones that also dont want to deal with it on the return trip. Once they have a fix to contribute, they again won't want to deal with Git, Spriggit, etc. I think this issue will be a big step towards filling out the workflow for this crowd.


How this might be done:

Prep:

Upload workflow:

  • User uses form to initiate. Fills out message, uploads zip, etc.
  • Upload that file somewhere (vercel blob?)
  • Start the github workflow via the Github API https://stackoverflow.com/a/70154713
  • Get PR with the resulting content
  • Maybe redirect user to the PR page? (unsure how this would be done, offhand)

This would give this style of user an easy way to drop off a fix without dealing (too much) with git.
Only downside might be they won't know how to follow up too well. They will have to get to the PR to have back and forth discussions. Also, we might need to find a way to add followup work. Maybe a similar workflow, but targeting a PR's ID as part of the dialog input?

Anyway, just brainstorming how to get the non-Git folks on board more cleanly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants