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

More detailed contribution guidance #2144

Open
hucknz opened this issue Sep 30, 2024 · 2 comments
Open

More detailed contribution guidance #2144

hucknz opened this issue Sep 30, 2024 · 2 comments
Labels
✨ Feature A feature you'd like to be added

Comments

@hucknz
Copy link

hucknz commented Sep 30, 2024

Description

Hi, I'd like to contribute a widget but I'm struggling with the contribution process, particularly around local builds for testing.

I have read through the Developer Guides documentation and there's great information around the IDE, etc. but I can't see anything about how to build locally.

I've also looked through the github issues and can see that building locally seems to be discouraged and there's not much in the way of guidance on how to do that.

I've also tried unpicking the github actions to do my own build but am encountering a lot of errors during that process and when the build does succeed my widget isn't included in the build.

I'm not a frontend developer so this is a little outside my normal world and I'm really struggling to get a local build going so I can test my widget out before I contribute a PR. Is there any guidance you can provide, or additions to the developer documentation, that can help me get started?

Priority

Medium (Would be very useful)

@hucknz hucknz added the ✨ Feature A feature you'd like to be added label Sep 30, 2024
Copy link

Hi 👋. Thank you for submitting your first issue to Homarr. Please ensure that you've provided all nessesary information. You can use the three dots > Edit button to update your post with additional images and information. Depending on the current volume of requests, the team should get in conact with you shortly.

@manuel-rw
Copy link
Collaborator

Hi, this is the wrong repository. You should open issues for documentation in homarr-labs/documentation.
I agree, documentation around local development could be better. I strongly recommend you to develop in the new version of Homarr (see #1993), available at homarr-labs/homarr. This code repository will be archived soon.
If you need help for development, I also suggest you to join the Discord.
The developer guides will not be updated for <1.0 because that version will not live for much longer. It will be updated as soon 1.0 is released.
Let me know if this answers your question and if you need further assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Feature A feature you'd like to be added
Projects
None yet
Development

No branches or pull requests

2 participants