First off, thank you for considering contributing towards Dashy! 🙌 There are several ways that you can help out (but don't feel you have to). Any contributions, every contribution, however small will always be very much appreciated, and you will be appropriately credited in the readme - huge thank you to everyone who has helped so far.
Contributing to the code or documentation is super helpful. You can fix a bug, add a new feature or improve an existing one. I've written several guides with step-by-step tutorials of common tasks within Dashy. For setting up the development envionment, outline of the standards, and understanding the PR flow, see the Deployment Docs. And I've tried to keep the code neat and documentation thorough, so understanding what everything does should be fairly straight forward, but feel free to ask if you have any questions.
If you speak another language, then adding translations would be really helpful, and you will be credited in the readme for your work. Multi-language support makes Dashy accessible for non-English speakers, which I feel is important. This is a very quick and easy task, , as all application text is located in locales/en.json, so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the Translating Docs.
If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary. You can Raise a Bug here 🐛.
I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users.
Dashy now has a Showcase where you can show off a screenshot of your dashboard, and get inspiration from other users. I also really enjoy seeing how people are using Dashy. To submit your dashboard, please either open a PR or raise an issue.
Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing on social platforms.
Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users find it.
- ProductHunt
- DockerHub
- GitHub
Please only do this is you can definitely afford to. Don't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever.
Sponsoring will give you several perks, from $1 / £0.70 per month, as well as a sponsor badge on your profile, you can also be credited on the readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see @Lissy93's Sponsor Page.
You can also send one-off small contriutions using crypto:
- BTC:
3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC - ETH:
0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017/aliciasykes.eth - XMR:
471KZdxb6N63aABR4WYwMRjTVkc1p1x7wGsUTEF7AMYzL8L94A5pCuYWkosgJQ5Ze8Y2PscVCGZFJa3hDPg6MaDq47GUm8r
