Contributions are very welcome, just open an issue or PR if you see something to improve!
Please note that all contributions happen under the MIT license as described at the bottom of this page.
Here are the recommended steps for new developers:
- Start by reading our non-technical primer and viewing the videos and articles on the blog
- Before writing code you will need to set up the dev environment
- Run the dev environment to ensure that everything works on your computer
- Now take a look at our GitHub Issues you may want to search for good first issues
- Introduce yourself on our Developer discord and ask any questions there
- Join our Developer calls especially the ones for new contributors
Small PRs fixing typos, TODOs, broken links are always welcome, but please discuss bigger changes on Discord or GitHub first.
For commits, please use imperative mood.
Happy hacking!
Below are some broad and general areas of contribution to get you started
- Fedimint Modules
- Fedimint Database System
- The Lightning Gateway
- Fedimint Guardian UI
- Nix Build System
- Integration tests
- Scripts
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.