Support
Do you want to contact me? You can email me at james@firefly-iii.org or get in touch through one of the following support channels:
- GitHub Discussions for questions and support
- Gitter.im for a good chat and a quick answer
- GitHub Issues for bugs and issues
- Mastodon for news and updates
Issues
If you found a bug, have a feature request or another idea for improvements, please open an issue on GitHub.
Roadmap
Check out the roadmap to see the future of Firefly III and the associated tools.
Who maintains Firefly III and why?
Firefly III is built and maintained by James Cole, a software developer from the Netherlands. He started developing Firefly III back in 2012, to manage his own finances.
You can contact him through email on james@firefly-iii.org. His PGP key is mentioned on Keybase.io. The fingerprint is 02F4 046C 4B23 6E06 0957 1612 B49A 324B 7EAD 6D80. You can verify that key.
Security considerations
Danger
If you find a security issue or problem with Firefly III, please refer to the Security Policy.
Support the development of Firefly III
Firefly III is a side gig. With your sponsorship or support, I can spend more time on Firefly III. So, if you like Firefly III, and if it helps you save lots of money, why not send me a dime for every dollar saved! 🥳
OK, that was a joke. But for real, when you feel Firefly III made your life better, please consider contributing as a sponsor. Please check out my Patreon and GitHub Sponsors page for more information. You can also buy me a ☕️ coffee at ko-fi.com or send something my way using Liberapay. Thank you for your consideration.
Sponsorships
Firefly III is sponsored by LamdaTest. Their support allows me to test Firefly III more easily and introduce even fewer bugs with every release.
Contributing code
I am always interested in expanding Firefly III's many features, and I always want to fix the many bugs there are. Please keep the following rules in mind, so we can both save a lot of time.
Rules
- If you see a bug, and your first reaction is to open a PR, please describe the bug and its fix very carefully. When your fix requires a lot of changes, please let me know beforehand. I cannot accept new features out of the blue. Please first discuss the change you wish to make via issue, email, or any other method.
- For some people, getting a PR merged is like a badge of honour. Low effort PRs that fix spelling errors or change a single broken HTML tag will not be accepted.
- I'm afraid Firefly III can't be your learning experience. If you're new to all of this, please go be new somewhere else, thank you.
- Do not open PRs to "discuss" possible solutions or to "get feedback" on your code. I don't have time for that.
- Pull requests for the
mainbranch will be closed automatically. - DO NOT include translated strings in your PR, your PR will be closed automatically.
Your code will be licensed under the current Firefly III license.
Firefly III is a passion project, and I am only accepting submissions from people who are as passionate as me about this application. Your drive-by resume-filling PR will not be accepted.
Developer certificate of origin
Please read the developer certificate of origin and agree and comply with it.
Contributing text and documentation
If you see a spelling error, grammatical error or a weird translation in your language, please join our CrowdIn project. There, you can submit your translations and fixes. The GitHub repository will download these automatically, and they will be included in the next release.
Know that I am always open for rewrites and more clarity in the documentation, but I will not accept changes that people can Google themselves already. For example, do not submit text that explains how to set up Docker. Or how to install PHP.
Any documentation you write or fix must be checked for correct spelling. If you correct my spelling or grammar, you don't make mistakes of your own.
Is your language not listed? You can send your language to me by email or open a ticket on GitHub.
Rules
- Read Google's guidelines for inclusive documentation.
- It's "Firefly III". Nothing else will be accepted.
- Do not use terminology like "just", "simple", "easy", or "all you have to do".
- Be informal and encouraging.
- Never be angry in your tone of voice when writing.
Credits
Firefly III uses the following libraries and tools:
- The AdminLTE template by Almsaseed Studio
- Chart.js
- Bootstrap
- Laravel
- Twig
- For development, some excellent tools made by Barry van den Heuvel
- Bootstrap sortable. by Matúš Brliť
- Date range picker by Dan Grossman
- The real favicon generator
- The favicon has been made by Smashicons.
- Alternative icon has been made by Freepik.
- The cute piggy is by Fabian Blank.
- Various other open source components (see composer.json)
- CSV file icon made by Smashicons.
License
Firefly III is licensed under the GNU Affero General Public License v3.0 (or later). Read more about this.